Create a Project
Scaffold an AgentOS project from a starter template: Docker by default, or AWS, Azure, Fly.io, GCP, Kubernetes, Modal, Railway, and Render.
agno create my-osagno create clones a starter template into a new directory, strips its git history, and seeds .env from the template's example.env when it ships one.
Add your secrets to my-os/.env, then:
cd my-os
agno up # start it with docker compose
agno connect # make it available in your coding agentsInteractive Mode
Run agno create with no arguments and the CLI walks you through both choices:
agno createIn capable terminals, select a starter with the arrow keys or a numeric shortcut, then press Enter; the default is agentos-docker. The plain-terminal fallback accepts a number or template name. It then asks for a project name (default agentos) and re-prompts until the name is valid and the directory is free.
Passing --template or --url skips the template question. An unknown --template fails before the first prompt appears.
With --json, or in any run where stdin is not a TTY, nothing prompts and the name argument is required.
Starter Templates
Pick a starter with --template:
agno create my-os --template agentos-aws| Template | Target | Repository |
|---|---|---|
agentos-docker (default) | Local dev and any Docker host | agno-agi/agentos-docker |
agentos-aws | AWS | agno-agi/agentos-aws |
agentos-azure | Azure | agno-agi/agentos-azure |
agentos-fly | Fly.io | agno-agi/agentos-fly |
agentos-gcp | Google Cloud | agno-agi/agentos-gcp |
agentos-helm | Kubernetes (Helm chart) | agno-agi/agentos-helm |
agentos-modal | Modal | agno-agi/agentos-modal |
agentos-railway | Railway | agno-agi/agentos-railway |
agentos-render | Render | agno-agi/agentos-render |
Every starter ships an AgentOS application, an example.env, and a compose file that agno up picks up. See Templates for the full catalog, including pre-built agent systems.
Custom Templates
Scaffold from any git repository, such as your team's internal starter:
agno create my-os --url https://github.com/acme/agentos-internalHow It Works
- Validates the name. It becomes a directory under the current directory, so it must be a single path segment of letters, digits,
-, and_. - Runs
git clone --depth 1on the template repository (git must be installed). - Removes the cloned
.gitdirectory, giving you a clean tree to init your own repo in. - Copies
example.envto.envwith owner-only permissions when the template ships one. An existing.envis never overwritten. If seeding fails, the cloned directory is removed so a retry starts clean.
The command fails if the target directory already exists. The CLI doesn't keep a registry of projects; up, down, and restart operate on whatever directory you run them from.
Next Steps
| Task | Guide |
|---|---|
| Start the project | agno up |
| Connect coding agents | agno connect |
| Deploy to production | Templates |