> ## Documentation Index
> Fetch the complete documentation index at: https://agno-v2.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

```bash theme={null}
agno create my-os
```

`agno 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:

```bash theme={null}
cd my-os
agno up       # start it with docker compose
agno connect  # make it available in your coding agents
```

## Interactive Mode

Run `agno create` with no arguments and the CLI walks you through both choices:

```bash theme={null}
agno create
```

It shows a numbered menu of starter templates. Answer with a number or a template name, or press Enter for `agentos-docker`. 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`:

```bash theme={null}
agno create my-os --template agentos-aws
```

| Template | Target | Repository |
| - | - | - |
| `agentos-docker` (default) | Local dev and any Docker host | [agno-agi/agentos-docker](https://github.com/agno-agi/agentos-docker) |
| `agentos-aws` | AWS | [agno-agi/agentos-aws](https://github.com/agno-agi/agentos-aws) |
| `agentos-azure` | Azure | [agno-agi/agentos-azure](https://github.com/agno-agi/agentos-azure) |
| `agentos-fly` | Fly.io | [agno-agi/agentos-fly](https://github.com/agno-agi/agentos-fly) |
| `agentos-gcp` | Google Cloud | [agno-agi/agentos-gcp](https://github.com/agno-agi/agentos-gcp) |
| `agentos-helm` | Kubernetes (Helm chart) | [agno-agi/agentos-helm](https://github.com/agno-agi/agentos-helm) |
| `agentos-modal` | Modal | [agno-agi/agentos-modal](https://github.com/agno-agi/agentos-modal) |
| `agentos-railway` | Railway | [agno-agi/agentos-railway](https://github.com/agno-agi/agentos-railway) |
| `agentos-render` | Render | [agno-agi/agentos-render](https://github.com/agno-agi/agentos-render) |

Every starter ships an AgentOS application, an `example.env`, and a compose file that `agno up` picks up. See [Templates](https://agno-v2.mintlify.site/deploy/introduction.md) for the full catalog, including pre-built agent systems.

## Custom Templates

Scaffold from any git repository, such as your team's internal starter:

```bash theme={null}
agno create my-os --url https://github.com/acme/agentos-internal
```

## How It Works

1. Validates the name. It becomes a directory under the current directory, so it must be a single path segment of letters, digits, `-`, and `_`.
2. Runs `git clone --depth 1` on the template repository (git must be installed).
3. Removes the cloned `.git` directory, giving you a clean tree to init your own repo in.
4. Copies `example.env` to `.env` with owner-only permissions when the template ships one. An existing `.env` is 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](https://agno-v2.mintlify.site/cli/operate.md) |
| Connect coding agents | [agno connect](https://agno-v2.mintlify.site/cli/connect.md) |
| Deploy to production | [Templates](https://agno-v2.mintlify.site/deploy/introduction.md) |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.