Skip to content
Docs

Basemodo documentation

Basemodo is a cloud for small software: deploy a folder with one command, or one sentence to your agent, get back a URL, and share it with the people it is for.

Every App on Basemodo gets its own machine with a disk that keeps its data, a SQLite database ready to use, and sign-in for its visitors. Basemodo tells your App who is visiting, so it never needs login code of its own. It sleeps when nobody uses it and wakes on the next visit. A new App is private: only you can open it until you share it.

  • New here? Getting started takes you from a folder on your computer to a link you can send, in plain words.
  • Working with an agent (Claude Code, Codex, Cursor)? Deploying with an agent sets it up in one line.
  • Looking for a command? The CLI lists every one, each with its own page and examples. The manifest, basemodo.toml, has every key on one page.
  • Got an error? Every error names its fix and links to its explanation.

This documentation is also in your terminal, as basemodo docs, and in one file for agents at /llms.txt. All three are written from the same source as the CLI's own --help, so they always agree.

Start here

  • Getting started: From a folder on your computer to a link you can send to your team, in five steps and plain words. No servers, databases or login code to set up.
  • Deploying with an agent: Let Claude Code, Codex, Cursor or any agent deploy, share and fix your Apps for you, with one line of setup and your own sign-in.

Guides

  • Deploying: What happens when you deploy a folder: what is sent, how Basemodo works out how to build and run it, when it goes live, and what happens when it fails.
  • Sharing: Who can open an App: its Visibility, the people you invite, and how they sign in.
  • Who is visiting: identity headers: How your App knows who is using it without any login code: Basemodo signs visitors in and sends their email, id and role with every request.
  • Secrets: Keep API keys, tokens and passwords out of your code: set them as Secrets, and your App gets them as environment variables.
  • Data: the disk, SQLite, db, run and Backups: Where your App keeps its data so it survives every Deploy and every sleep, the SQLite database every App already has, and how to query it or run a script where the data is.
  • Public Paths: webhooks: Let Stripe, Trello, GitHub or any other system call your App without signing in, on the few paths you name, while the rest of the App stays protected.
  • Workers and cron: Run code besides the web: a worker that runs all the time (a queue, a bot), or a cron entry that runs on a schedule (a nightly report), declared in the manifest.
  • Deploying from GitHub: Link an App to a GitHub repository and every push to its branch deploys it, with no terminal involved.
  • Domains: Where an App lives: its address on basemodo.app, your own domain with HTTPS, and what happens to links when you rename it.

Concepts

  • How Apps run: What an App is on Basemodo: one machine with its own disk, the port it must answer on, how it sleeps and wakes, and what it may reach.
  • Roles: Who can do what with an App: its Owner, its Members, its Editors, and the Admins of a Workspace.
  • Plans: What you pay for: three Plans at flat prices with hard limits, a seven-day Trial to start, and never a surprise bill.

Reference

  • The basemodo CLI: Every command of basemodo, the program that deploys and shares your Apps from a terminal, a script or an agent, with how it signs in and how it prints.
  • The manifest: basemodo.toml: Every key of basemodo.toml, the optional file that names your App and says what detection cannot know: its start command, runtime versions, workers, cron entries and Public Paths.
  • Supported runtimes: What Basemodo recognizes in a folder with no configuration, how it builds and starts each, and what to do when your App is something else.
  • Errors: Every error Basemodo can answer, by its code: what it means and what to do. Each error links here, to its own entry.