From 998d9b1c76995bd3e8ebb1192be15a3cd3b11843 Mon Sep 17 00:00:00 2001 From: Himanshu Singh Date: Wed, 5 Aug 2026 11:46:03 +0530 Subject: [PATCH 1/3] docs: update agno create for the v2.7.4 onboarding changes - document interactive mode: bare agno create prompts for template and project name; --json / non-TTY runs still require a name - add the four new starters (azure, helm, modal, render) to the starter table and the --template flag list - drop the manual cp example.env .env step: create now seeds .env automatically (owner-only permissions, never overwrites, cleans up on failure) --- cli/create.mdx | 25 ++++++++++++++++++++++--- cli/overview.mdx | 4 ++-- reference/cli/agnoctl.mdx | 6 +++--- 3 files changed, 27 insertions(+), 8 deletions(-) diff --git a/cli/create.mdx b/cli/create.mdx index 6b618abe4..2e44578c3 100644 --- a/cli/create.mdx +++ b/cli/create.mdx @@ -1,22 +1,36 @@ --- title: "Create a Project" sidebarTitle: "agno create" -description: "Scaffold an AgentOS project from a starter template: Docker by default, or AWS, Fly.io, GCP, and Railway." +description: "Scaffold an AgentOS project from a starter template: Docker by default, or AWS, Azure, Fly.io, GCP, Kubernetes, Modal, Railway, and Render." --- ```bash agno create my-os ``` -`agno create` clones a starter template into a new directory, strips its git history, and prints the next steps: +`agno create` clones a starter template into a new directory, strips its git history, seeds `.env` from the template's `example.env`, and prints the next steps: ```bash cd my-os -cp example.env .env # then fill in your secrets +# add your secrets to .env, then: agno up # start it with docker compose agno connect # make it available in your coding agents ``` +## Interactive Mode + +Run it bare and the CLI walks you through both choices: + +```bash +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`: @@ -29,9 +43,13 @@ agno create my-os --template agentos-aws |----------|--------|------------| | `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](/deploy/introduction) for the full catalog, including pre-built agent systems. @@ -48,6 +66,7 @@ agno create my-os --url https://github.com/acme/agentos-internal 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, and 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. diff --git a/cli/overview.mdx b/cli/overview.mdx index 6baac3c2c..422fe70f7 100644 --- a/cli/overview.mdx +++ b/cli/overview.mdx @@ -7,7 +7,7 @@ description: "Scaffold, run, and connect an AgentOS from the terminal with the a ```bash agno create my-os cd my-os -cp example.env .env # fill in your secrets +# add your secrets to .env agno up agno connect ``` @@ -34,7 +34,7 @@ uvx agnoctl connect | Command | What it does | Guide | |---------|--------------|-------| -| `agno create ` | Scaffold a project from a starter template | [Create a project](/cli/create) | +| `agno create [name]` | Scaffold a project from a starter template, prompting when the name is omitted | [Create a project](/cli/create) | | `agno connect` | Connect coding agents to a running AgentOS over MCP | [Connect your clients](/cli/connect) | | `agno disconnect` | Remove AgentOS MCP entries from client configs | [Connect your clients](/cli/connect) | | `agno up` / `down` / `restart` | Run the project with Docker Compose | [Operate your AgentOS](/cli/operate) | diff --git a/reference/cli/agnoctl.mdx b/reference/cli/agnoctl.mdx index d3f038874..9878fc2ca 100644 --- a/reference/cli/agnoctl.mdx +++ b/reference/cli/agnoctl.mdx @@ -89,14 +89,14 @@ Service-account object (the plaintext token is excluded): ## agno create ```bash -agno create [--template ] [--url ] [--json] +agno create [name] [--template ] [--url ] [--json] ``` -Scaffolds a project by shallow-cloning a template repository (`git clone --depth 1`, 300s timeout) into `./` and removing its `.git` directory. It requires `git` and fails if the directory already exists. `` must be a single path segment of letters, digits, `-`, and `_`. +Scaffolds a project by shallow-cloning a template repository (`git clone --depth 1`, 300s timeout) into `./`, removing its `.git` directory, and copying `example.env` to `.env` when the template ships one (created with owner-only permissions; an existing `.env` is never overwritten, and symlinked `example.env` or `.env` files are refused). It requires `git` and fails if the directory already exists. `` must be a single path segment of letters, digits, `-`, and `_`. A run with no `name` argument prompts for the template and the project name; with `--json` or a non-TTY stdin, prompts are disabled and `` is required. | Flag | Default | Description | |------|---------|-------------| -| `--template`, `-t` | `agentos-docker` | Starter template: `agentos-aws`, `agentos-docker`, `agentos-fly`, `agentos-gcp`, `agentos-railway` | +| `--template`, `-t` | `agentos-docker` | Starter template: `agentos-aws`, `agentos-azure`, `agentos-docker`, `agentos-fly`, `agentos-gcp`, `agentos-helm`, `agentos-modal`, `agentos-railway`, `agentos-render` | | `--url`, `-u` | none | Clone from a custom template repository URL instead | | `--json` | off | Emit a single JSON document | From b12e0f3b9539933e048b8a189876d3218396e61b Mon Sep 17 00:00:00 2001 From: Himanshu Singh Date: Wed, 5 Aug 2026 12:47:33 +0530 Subject: [PATCH 2/3] docs: tighten agno create wording per review --- cli/create.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/cli/create.mdx b/cli/create.mdx index 2e44578c3..b5435bc26 100644 --- a/cli/create.mdx +++ b/cli/create.mdx @@ -8,7 +8,7 @@ description: "Scaffold an AgentOS project from a starter template: Docker by def agno create my-os ``` -`agno create` clones a starter template into a new directory, strips its git history, seeds `.env` from the template's `example.env`, and prints the next steps: +`agno create` clones a starter template into a new directory, strips its git history, seeds `.env` from the template's `example.env` when it ships one, and prints the next steps: ```bash cd my-os @@ -19,7 +19,7 @@ agno connect # make it available in your coding agents ## Interactive Mode -Run it bare and the CLI walks you through both choices: +Run `agno create` with no arguments and the CLI walks you through both choices: ```bash agno create @@ -66,7 +66,7 @@ agno create my-os --url https://github.com/acme/agentos-internal 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, and if seeding fails the cloned directory is removed so a retry starts clean. +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. From dfd1b5671a402e4cacb288cb8a705d333278c444 Mon Sep 17 00:00:00 2001 From: Harsh Sinha Date: Wed, 5 Aug 2026 13:52:52 +0530 Subject: [PATCH 3/3] update --- cli/create.mdx | 9 +++++---- reference/cli/agnoctl.mdx | 2 +- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/cli/create.mdx b/cli/create.mdx index b5435bc26..60bf50c96 100644 --- a/cli/create.mdx +++ b/cli/create.mdx @@ -8,13 +8,14 @@ description: "Scaffold an AgentOS project from a starter template: Docker by def agno create my-os ``` -`agno create` clones a starter template into a new directory, strips its git history, seeds `.env` from the template's `example.env` when it ships one, and prints the next steps: +`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 cd my-os -# add your secrets to .env, then: -agno up # start it with docker compose -agno connect # make it available in your coding agents +agno up # start it with docker compose +agno connect # make it available in your coding agents ``` ## Interactive Mode diff --git a/reference/cli/agnoctl.mdx b/reference/cli/agnoctl.mdx index 9878fc2ca..a7c9a5bb0 100644 --- a/reference/cli/agnoctl.mdx +++ b/reference/cli/agnoctl.mdx @@ -92,7 +92,7 @@ Service-account object (the plaintext token is excluded): agno create [name] [--template ] [--url ] [--json] ``` -Scaffolds a project by shallow-cloning a template repository (`git clone --depth 1`, 300s timeout) into `./`, removing its `.git` directory, and copying `example.env` to `.env` when the template ships one (created with owner-only permissions; an existing `.env` is never overwritten, and symlinked `example.env` or `.env` files are refused). It requires `git` and fails if the directory already exists. `` must be a single path segment of letters, digits, `-`, and `_`. A run with no `name` argument prompts for the template and the project name; with `--json` or a non-TTY stdin, prompts are disabled and `` is required. +Scaffolds a project by shallow-cloning a template repository (`git clone --depth 1`, 300s timeout) into `./`, removing its `.git` directory, and copying `example.env` to `.env` when the template ships one (created with owner-only permissions; an existing `.env` is never overwritten, and symlinked `example.env` or `.env` files are refused). It requires `git` and fails if the directory already exists. `` must be a single path segment of letters, digits, `-`, and `_`. A run with no `name` argument prompts for the project name, and for the template unless `--template` or `--url` is passed; with `--json` or a non-TTY stdin, prompts are disabled and `` is required. | Flag | Default | Description | |------|---------|-------------|