Add Agents CLI quickstart to Get Started - #2095
Conversation
Agents CLI is currently explained only under Deploy > Agent Runtime and in the Coding with AI tutorial, so readers reach it either not at all or with the impression that it only configures AI coding assistants. Add a quickstart alongside the language quickstarts, and a card on the Get Started index so the choice is made up front.
Lead with the coding agent as the intended way to use Agents CLI, add the lifecycle diagram and the seven skills, and say the CLI has more than 25 commands so the skills do not read as the whole product. Name the real Phase 0 questions (tools, inputs and outputs, success criteria) and close the loop in Next steps, where evaluation grades against those criteria. Drop the manual command section in favour of the upstream manual workflow tutorial, drop the playground production warning, and use Antigravity rather than Antigravity CLI to match the rest of the docs.
✅ Deploy Preview for adk-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| [skills](https://agentskills.io/what-are-skills). Most agents list them | ||
| through a `/skills` command or a settings panel. | ||
|
|
||
| Then tell it what you want to build: |
There was a problem hiding this comment.
be more specific:
tell it --> tell the coding agent
| @@ -0,0 +1,214 @@ | |||
| # Agents CLI Quickstart for ADK | |||
|
|
|||
| [Agents CLI in Agent Platform](https://google.github.io/agents-cli/) is a CLI | |||
There was a problem hiding this comment.
The purpose of this introduction is to explain that you can use Agent CLI to setup and install ADK, and briefly why a developer might chose to do that. Make sure you mention that this setup can work with multiple coding agents.
Rewrite this introduction. Keep it focused: 3-4 sentences max.
There was a problem hiding this comment.
Rewrote to 4 sentences: what Agents CLI does (installs ADK + scaffolds + teaches your coding agent), which agents it works with (Antigravity, Claude Code, Codex, any skill-aware agent), and when to reach for it. bb56950
| Google Cloud**: scaffolding, evaluation, deployment, and observability. Your | ||
| agents are built with the Agent Development Kit (ADK). | ||
|
|
||
|  |
There was a problem hiding this comment.
This introduction is completely overblown. It's not appropriate to be putting the equivalent of a full-page advertisement for Agents CLI into what is supposed to be a "quickstart". A quickstart is supposed to be quick: To the point, no fluff. Get it working and get on to the next thing.
Remove everything from the image down to the "Prerequisites" heading.
There was a problem hiding this comment.
Trimmed as suggested — dropped the coding-agent-path paragraph, the "Agents CLI is optional" paragraph, and the seven-skills table. Kept the lifecycle diagram (see reply on the image comment). Intro → diagram → Prerequisites in ~11 lines now instead of ~33. bb56950
| gcloud auth application-default login | ||
| ``` | ||
|
|
||
| ??? tip "Using a Gemini API key instead" |
There was a problem hiding this comment.
This should be the default option, not the alternative.
There was a problem hiding this comment.
Done — Gemini API key is the default snippet now; Google Cloud is the linked alternative below it. bb56950
| your Application Default Credentials and needs no further setup: | ||
|
|
||
| ```shell | ||
| gcloud auth application-default login |
There was a problem hiding this comment.
do not present this dependency on Google Cloud the default option.
ADK is committed to being platform agnostic, and presenting Google Cloud as a default implementation contradicts that.
Also, connecting to Google Cloud is non-trivial (especially from a standing start) and there are multiple connection paths, you can present a simple one, but also provide a link to the Cloud connection guide for more details: https://adk.dev/get-started/google-cloud/
There was a problem hiding this comment.
Agreed — reordered so the Gemini API key path is the default snippet. Google Cloud moved into a collapsed ??? note linking to get-started/google-cloud.md for the full connection guide (quotas, regions, enterprise auth). bb56950
|
|
||
| Check that the Agents CLI skills are available in your environment. | ||
|
|
||
| === "Any other agent" |
There was a problem hiding this comment.
don't make this a tab, use a note to explain this, because it's not an equivalent instruction to the other options:
??? note "Using other coding agents"
Agents CLI works with any coding agent that...
There was a problem hiding this comment.
Done — moved out of the tabs into ??? note "Using other coding agents" right below the three tabs. bb56950
| Your coding agent activates the `google-agents-cli-workflow` and | ||
| `google-agents-cli-scaffold` skills. It asks clarifying questions about the | ||
| tools your agent calls, the inputs and outputs you expect, and the success | ||
| criteria to evaluate against, then scaffolds the project: |
There was a problem hiding this comment.
add an explanatory sentence at the end of this paragraph. What are these commands you are presenting? Is the reader supposed to execute them? is the coding agent running this?
There was a problem hiding this comment.
Added an explanatory sentence at the end of the paragraph: "It runs the commands below on your behalf — you can also run them directly in a terminal if you prefer." Matches the pattern you called out on L185. bb56950
|
|
||
| ## Run your agent | ||
|
|
||
| Ask your coding agent to start the local playground, or run it yourself: |
There was a problem hiding this comment.
Here you explain the intended use of the command that follow. Do the same on line 152 (see comment).
There was a problem hiding this comment.
Done — L152 now matches this pattern (see reply on that thread). bb56950
| ## Installation | ||
|
|
||
| Install Agents CLI by running the following command. This is the only command | ||
| you run yourself; the rest of this guide goes through your coding agent. |
There was a problem hiding this comment.
Does this step install ADK libraries? I assume "yes", but that's not clear. State that clearly in this introduction paragraph, otherwise it seems like the reader is just installing Agents CLI.
There was a problem hiding this comment.
Clarified: uvx google-agents-cli setup now explicitly states it installs the agents-cli command, the ADK Python packages your project will need, AND the ADK skills. Reader no longer has to guess whether they still owe a separate pip install google-adk. bb56950
| [:octicons-arrow-right-24: Start with Agents CLI](agents-cli.md) <br> | ||
| </div> | ||
|
|
||
| The language quickstarts start from a single-file agent and teach ADK itself. |
There was a problem hiding this comment.
remove this paragraph. this is unnecessary and almost no one is going to read it, regardless, because of it's placement.
There was a problem hiding this comment.
remove. (see later comments on why)
There was a problem hiding this comment.
Kept the lifecycle diagram in — visual reference for the 10-stage lifecycle at a glance. Cut everything else you flagged (coding-agent-path paragraph, seven-skills table, "Agents CLI is optional" paragraph). Happy to drop the image too if you'd still prefer, just wanted to preserve at least one visual anchor for scope. bb56950
- Tighten intro to 3-4 sentences; drop the coding-agent-path paragraph, the "optional / ordinary ADK agents" paragraph, and the seven-skills table (kept the lifecycle diagram) - Installation: state clearly that setup also installs the ADK Python packages, not just the CLI - Authenticate: swap the default to the Gemini API key path; move Google Cloud into a linked note pointing to the Google Cloud setup guide - Build your agent: replace prose in each tab with a command block containing verification steps as comments; move "Any other agent" out of the tabs into a note; "tell it" -> "tell the coding agent" - Add explanatory sentence before the scaffold command block clarifying that the coding agent runs the commands (and the reader can too) - Get Started index: drop the language-quickstarts-vs-Agents-CLI framing paragraph (unlikely to be read in that position)
Stage: https://deploy-preview-2095--adk-docs-preview.netlify.app/get-started/agents-cli/
Summary
adk createandagents-cli createis visible up front.Changes
docs/get-started/agents-cli.md(new), following the structure of the language quickstartsdocs/get-started/index.md: Agents CLI cardmkdocs.yml: nav entrydocs/assets/agents-cli-lifecycle.png: lifecycle diagram