skills/google__adk-docs
1
0
Fork 0
mirror of https://github.com/google/adk-docs.git synced 2026-09-14 16:16:59 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
GlobalInstructionPlugin_example
google__adk-docs/mkdocs.yml
T
eliasecchig 979a8fa9db Add Agents CLI quickstart to Get Started (#2095) 
* Add Agents CLI quickstart to Get Started

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.

* Rework the quickstart around the coding agent path

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.

* Address review feedback on Agents CLI quickstart

- 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)

* Update agents-cli.md

* Update agents-cli.md

* Delete docs/assets/agents-cli-lifecycle.png

---------

Co-authored-by: pierpaolo28 <pierpaolo28@users.noreply.github.com>
Co-authored-by: Joe Fernandez <931947+joefernandez@users.noreply.github.com>
2026-08-21 16:57:39 -07:00

465 lines
18 KiB
YAML
Raw Permalink Blame History

# Project information
site_name: Agent Development Kit (ADK)
site_url: https://adk.dev
site_description: >-
Build powerful multi-agent systems with Agent Development Kit (ADK)
site_dir: site
exclude_docs: |
api-reference/java/legal/*
/_includes/**
not_in_nav: |
/integrations/*.md
# Repository
repo_name: adk-docs
repo_url: https://github.com/google/adk-docs
edit_uri: edit/main/docs/
# Copyright
copyright: Copyright Google 2026&nbsp;&nbsp;|&nbsp;&nbsp;<a href="//github.com/google/adk-docs/blob/main/LICENSE">License</a>&nbsp;&nbsp;|&nbsp;&nbsp;<a href="//policies.google.com/privacy">Privacy</a>&nbsp;&nbsp;|&nbsp;&nbsp;<a href="#__consent">Manage cookies</a>
# Validation
validation:
absolute_links: ignore
# Custom CSS
extra_css:
- stylesheets/custom.css
- stylesheets/language-tags.css
# Custom JavaScript
extra_javascript:
- javascript/copy-page.js
# Additional config
extra:
analytics:
provider: google
property: G-DKHZS27PHP
consent:
title: Cookie consent
description: >-
We use cookies to recognize repeated visits and preferences,
as well as to measure the effectiveness of our documentation and
whether users find the information they need. With your consent,
you're helping us to make our documentation better.
# Configuration
theme:
name: material
font:
text: Roboto
code: Roboto Mono
logo: assets/agent-development-kit.png
favicon: assets/agent-development-kit.png
icon:
repo: fontawesome/brands/github
custom_dir: overrides
palette:
- scheme: default
primary: white
accent: white
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: grey
accent: grey
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- content.action.edit
- content.action.view
- content.code.copy
- content.tabs.link
- content.tooltips
- navigation.indexes
- navigation.instant
- navigation.instant.progress
- navigation.path
- navigation.sections
- navigation.top
- navigation.tabs
- toc.follow
# Extensions
markdown_extensions:
- admonition
- attr_list
- md_in_html
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets:
check_paths: true
dedent_subsections: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- toc:
permalink: true
# Hooks
hooks:
- hooks/pagefind.py
# Plugins
plugins:
- macros:
module_name: scripts/integrations
# Set custom delimiters for J2 templates to avoid conflicts with Markdown
# alternative to {% %}
j2_block_start_string: '{{%'
j2_block_end_string: '%}}'
# alternative to {{ }}
j2_variable_start_string: '{{$'
j2_variable_end_string: '$}}'
# alternative to {# #}
j2_comment_start_string: '{{#'
j2_comment_end_string: '#}}'
- redirects:
redirect_maps:
'get-started/local-testing.md': 'runtime/api-server.md'
'get-started/tutorial.md': 'tutorials/index.md'
'guides/responsible-agents.md': 'safety/index.md'
'tools/third-party-tools.md': 'integrations/index.md'
'tools/third-party/openapi-tools.md': 'tools-custom/openapi-tools.md'
'tools/openapi-tools.md': 'tools-custom/openapi-tools.md'
'tutorials/ag-ui.md': 'integrations/ag-ui.md'
'tools/third-party/langchain.md': 'integrations/index.md'
'tools/third-party/crewai.md': 'integrations/index.md'
'get-started/testing.md': 'runtime/api-server.md'
'tools/authentication.md': 'tools-custom/authentication.md'
'tools/function-tools.md': 'tools-custom/function-tools.md'
'tools/confirmation.md': 'tools-custom/confirmation.md'
'tools/performance.md': 'tools-custom/performance.md'
'tools/mcp-tools.md': 'tools-custom/mcp-tools.md'
'tools/google-cloud/bigquery-agent-analytics.md': 'integrations/bigquery-agent-analytics.md'
'tools/google-cloud-tools.md': 'integrations/index.md'
'tools/built-in-tools.md': 'integrations/index.md'
'sessions/rewind.md': 'sessions/session/rewind.md'
'tools/third-party/ag-ui.md': 'integrations/ag-ui.md'
'tools/google-cloud/api-registry.md': 'integrations/api-registry.md'
'tools/google-cloud/apigee-api-hub.md': 'integrations/apigee-api-hub.md'
'tools/google-cloud/application-integration.md': 'integrations/application-integration.md'
'tools/third-party/asana.md': 'integrations/asana.md'
'tools/third-party/atlassian.md': 'integrations/atlassian.md'
'tools/google-cloud/bigquery.md': 'integrations/bigquery.md'
'tools/google-cloud/bigtable.md': 'integrations/bigtable.md'
'tools/third-party/cartesia.md': 'integrations/cartesia.md'
'tools/third-party/chroma.md': 'integrations/chroma.md'
'tools/google-cloud/code-exec-agent-engine.md': 'integrations/code-exec-agent-runtime.md'
'integrations/code-exec-agent-engine.md': 'integrations/code-exec-agent-runtime.md'
'tools/gemini-api/code-execution.md': 'integrations/code-execution.md'
'tools/gemini-api/computer-use.md': 'integrations/computer-use.md'
'tools/google-cloud/data-agent.md': 'integrations/data-agent.md'
'tools/third-party/daytona.md': 'integrations/daytona.md'
'tools/third-party/elevenlabs.md': 'integrations/elevenlabs.md'
'tools/google-cloud/express-mode.md': 'integrations/express-mode.md'
'tools/third-party/github.md': 'integrations/github.md'
'tools/third-party/gitlab.md': 'integrations/gitlab.md'
'tools/google-cloud/gke-code-executor.md': 'integrations/gke-code-executor.md'
'tools/gemini-api/google-search.md': 'integrations/google-search.md'
'tools/third-party/hugging-face.md': 'integrations/hugging-face.md'
'tools/third-party/linear.md': 'integrations/linear.md'
'tools/google-cloud/mcp-toolbox-for-databases.md': 'integrations/mcp-toolbox-for-databases.md'
'tools/third-party/mongodb.md': 'integrations/mongodb.md'
'tools/third-party/n8n.md': 'integrations/n8n.md'
'tools/third-party/notion.md': 'integrations/notion.md'
'tools/third-party/paypal.md': 'integrations/paypal.md'
'tools/third-party/postman.md': 'integrations/postman.md'
'tools/google-cloud/pubsub.md': 'integrations/pubsub.md'
'tools/third-party/qdrant.md': 'integrations/qdrant.md'
'tools/google-cloud/spanner.md': 'integrations/spanner.md'
'tools/third-party/stripe.md': 'integrations/stripe.md'
'tools/google-cloud/vertex-ai-rag-engine.md': 'integrations/knowledge-engine.md'
'integrations/vertex-ai-rag-engine.md': 'integrations/knowledge-engine.md'
'integrations/rag-engine.md': 'integrations/knowledge-engine.md'
'tools/google-cloud/vertex-ai-search.md': 'integrations/agent-search.md'
'integrations/vertex-ai-search.md': 'integrations/agent-search.md'
'grounding/vertex_ai_search_grounding.md': 'grounding/grounding_with_search.md'
'agents/models/vertex.md': 'agents/models/agent-platform.md'
'deploy/agent-engine/index.md': 'deploy/agent-runtime/index.md'
'deploy/agent-engine/deploy.md': 'deploy/agent-runtime/deploy.md'
'deploy/agent-engine/asp.md': 'deploy/agent-runtime/agents-cli.md'
'deploy/agent-runtime/asp.md': 'deploy/agent-runtime/agents-cli.md'
'deploy/agent-engine/test.md': 'deploy/agent-runtime/test.md'
'tools/index.md': 'integrations/index.md'
'tools/gemini-api/index.md': 'integrations/index.md'
'tools/google-cloud/index.md': 'integrations/index.md'
'tools/third-party/index.md': 'integrations/index.md'
'plugins/reflect-and-retry.md': 'integrations/reflect-and-retry.md'
'observability/bigquery-agent-analytics.md': 'integrations/bigquery-agent-analytics.md'
'observability/cloud-trace.md': 'integrations/cloud-trace.md'
'observability/freeplay.md': 'integrations/freeplay.md'
'observability/mlflow.md': 'integrations/mlflow-tracing.md'
'integrations/mlflow.md': 'integrations/mlflow-tracing.md'
'integrations/mimir.md': 'integrations/perseus-vault.md'
'observability/monocle.md': 'integrations/monocle.md'
'observability/phoenix.md': 'integrations/phoenix.md'
'observability/weave.md': 'integrations/weave.md'
'observability/agentops.md': 'integrations/agentops.md'
'observability/arize-ax.md': 'integrations/arize-ax.md'
'contributing-guide.md': 'community/contributing-guide.md'
'get-started/quickstart.md': get-started/index.md
'agents/multi-agents.md': workflows/index.md
'workflows/graphs.md': graphs/index.md
'workflows/graph-routes.md': graphs/routes.md
'workflows/human-input.md': graphs/human-input.md
'workflows/data-handling.md': graphs/data-handling.md
'workflows/dynamic.md': graphs/dynamic.md
'streaming/index.md': 'live/index.md'
'streaming/streaming-tools.md': 'live/streaming-tools.md'
'streaming/configuration.md': 'live/configuration.md'
'streaming/dev-guide/part1.md': 'live/dev-guide/part1.md'
'streaming/dev-guide/part2.md': 'live/dev-guide/part2.md'
'streaming/dev-guide/part3.md': 'live/dev-guide/part3.md'
'streaming/dev-guide/part4.md': 'live/dev-guide/part4.md'
'streaming/dev-guide/part5.md': 'live/dev-guide/part5.md'
'get-started/streaming/index.md': 'live/get-started/index.md'
'get-started/streaming/quickstart-streaming.md': 'live/get-started/streaming-python.md'
'get-started/streaming/quickstart-streaming-java.md': 'live/get-started/streaming-java.md'
- llmstxt:
markdown_description: An open-source, code-first toolkit for building, evaluating, and deploying sophisticated AI agents with flexibility and control.
full_output: llms-full.txt
sections:
Build Agents:
- get-started/*.md
- tutorials/*.md
- agents/*.md
- graphs/*.md
- workflows/*.md
- integrations/*.md
Run Agents:
- runtime/*.md
- visual-builder/*.md
- deploy/*.md
- observability/*.md
- evaluate/*.md
- optimize/*.md
- safety/*.md
Components:
- tools/*.md
- tools-custom/*.md
- skills/*.md
- context/*.md
- sessions/*.md
- callbacks/*.md
- artifacts/*.md
- events/*.md
- apps/*.md
- plugins/*.md
- mcp/*.md
- a2a/*.md
- live/*.md
- grounding/*.md
Reference:
- release-notes.md
- 2.0/index.md
- api-reference/index.md
Community:
- community/*.md
# Navigation
nav:
- Home: index.md
- Build Agents:
- Get Started:
- get-started/index.md
- Python: get-started/python.md
- TypeScript: get-started/typescript.md
- Go: get-started/go.md
- Java: get-started/java.md
- Kotlin: get-started/kotlin.md
- Agents CLI: get-started/agents-cli.md
- Installation: get-started/installation.md
- Google Cloud: get-started/google-cloud.md
- Build your Agent:
- tutorials/index.md
- Multi-tool agent: tutorials/multi-tool-agent.md
- Agent team: tutorials/agent-team.md
- Code with AI: tutorials/coding-with-ai.md
- Agent Config: agents/config.md
- Agents:
- agents/index.md
- Simple agents: agents/llm-agents.md
- Managed agents: agents/managed-agents.md
- Graph Workflows:
- graphs/index.md
- Graph routes: graphs/routes.md
- Data handling: graphs/data-handling.md
- Human input: graphs/human-input.md
- Dynamic workflows: graphs/dynamic.md
- Multi-Agent Workflows:
- workflows/index.md
- Collaborative workflows: workflows/collaboration.md
- Template workflows:
- agents/workflow-agents/index.md
- Sequential workflow: agents/workflow-agents/sequential-agents.md
- Loop workflow: agents/workflow-agents/loop-agents.md
- Parallel workflow: agents/workflow-agents/parallel-agents.md
- Custom template workflows: agents/custom-agents.md
- Agent routing: agents/routing.md
- Workflow patterns: workflows/patterns.md
- Models for Agents:
- agents/models/index.md
- Gemini: agents/models/google-gemini.md
- Gemma: agents/models/google-gemma.md
- Claude: agents/models/anthropic.md
- Agent Platform hosted: agents/models/agent-platform.md
- Apigee AI Gateway: agents/models/apigee.md
- Model routing: agents/models/routing.md
- OpenAI: agents/models/openai.md
- Ollama: agents/models/ollama.md
- vLLM: agents/models/vllm.md
- LiteLLM: agents/models/litellm.md
- LiteRT-LM: agents/models/litert-lm.md
- Run Agents:
- Agent Runtime:
- Agent Runtime: runtime/index.md
- Web Interface:
- runtime/web-interface/index.md
- Visual Builder: visual-builder/index.md
- Command Line: runtime/command-line.md
- API Server: runtime/api-server.md
- Ambient Agents: runtime/ambient-agents.md
- Resume Agents: runtime/resume.md
- Cancel Agent Runs: runtime/cancel.md
- Runtime Config: runtime/runconfig.md
- Event Loop: runtime/event-loop.md
- Deployment:
- deploy/index.md
- Agent Runtime:
- deploy/agent-runtime/index.md
- Standard deployment: deploy/agent-runtime/deploy.md
- agents-cli: deploy/agent-runtime/agents-cli.md
- Test deployed agents: deploy/agent-runtime/test.md
- Cloud Run: deploy/cloud-run.md
- GKE: deploy/gke.md
- Observability:
- observability/index.md
- Logging: observability/logging.md
- Metrics: observability/metrics.md
- Traces: observability/traces.md
- Evaluation:
- evaluate/index.md
- Criteria: evaluate/criteria.md
- User Simulation: evaluate/user-sim.md
- Environment Simulation: evaluate/environment_simulation.md
- Custom Metrics: evaluate/custom_metrics.md
- Optimization: optimize/index.md
- Safety and Security:
- safety/index.md
- Components:
- Technical Overview: get-started/about.md
- Custom Tools:
- tools-custom/index.md
- Function tools:
- Overview: tools-custom/function-tools.md
- Tool performance: tools-custom/performance.md
- Action confirmations: tools-custom/confirmation.md
- MCP tools: tools-custom/mcp-tools.md
- OpenAPI tools: tools-custom/openapi-tools.md
- Authentication: tools-custom/authentication.md
- Tool limitations: tools/limitations.md
- Artifacts:
- artifacts/index.md
- Skills for Agents:
- skills/index.md
- App management:
- apps/index.md
- Callbacks:
- callbacks/index.md
- Types of callbacks: callbacks/types-of-callbacks.md
- Callback patterns: callbacks/design-patterns-and-best-practices.md
- Plugins: plugins/index.md
- Agent context:
- context/index.md
- Conversational context: sessions/index.md
- Sessions:
- sessions/session/index.md
- Rewind sessions: sessions/session/rewind.md
- Migrate sessions: sessions/session/migrate.md
- State: sessions/state.md
- Events: events/index.md
- Memory: sessions/memory.md
- Context compression: context/compaction.md
- Model context caching: context/caching.md
- MCP:
- mcp/index.md
- A2A Protocol:
- a2a/index.md
- Introduction to A2A: a2a/intro.md
- A2A Quickstart (Exposing):
- Python: a2a/quickstart-exposing.md
- Go: a2a/quickstart-exposing-go.md
- Java: a2a/quickstart-exposing-java.md
- A2A Quickstart (Consuming):
- Python: a2a/quickstart-consuming.md
- Go: a2a/quickstart-consuming-go.md
- Java: a2a/quickstart-consuming-java.md
- Kotlin: a2a/quickstart-consuming-kotlin.md
- A2A Extension: a2a/a2a-extension.md
- Live and Voice Agents:
- live/index.md
- Get started:
- live/get-started/index.md
- Python: live/get-started/streaming-python.md
- Java: live/get-started/streaming-java.md
- Gemini Live API Toolkit development guide:
- Part 1. Intro to streaming: live/dev-guide/part1.md
- Part 2. Sending messages: live/dev-guide/part2.md
- Part 3. Event handling: live/dev-guide/part3.md
- Part 4. Run configuration: live/dev-guide/part4.md
- Part 5. Audio, Images, and Video: live/dev-guide/part5.md
- Streaming Tools: live/streaming-tools.md
- Configuring streaming behavior: live/configuration.md
- Grounding:
- grounding/index.md
- Google Search Grounding: grounding/google_search_grounding.md
- Grounding with Search: grounding/grounding_with_search.md
- Integrations:
- integrations/index.md
- Reference:
- API Reference:
- api-reference/index.md
- Python ADK: api-reference/python/index.html
- TypeScript ADK: api-reference/typescript/index.html
- Go ADK:
- Go v2.x: https://pkg.go.dev/google.golang.org/adk/v2" target="_blank
- Go v1.x: https://pkg.go.dev/google.golang.org/adk" target="_blank
- Java ADK: api-reference/java/index.html
- Kotlin ADK: api-reference/kotlin/index.html
- CLI Reference: api-reference/cli/index.html
- Agent Config Reference: api-reference/agentconfig/index.html
- REST API: api-reference/rest/index.html
- Release Notes: release-notes.md
- Community:
- community/index.md
- Contributing Guide: community/contributing-guide.md
- ADK 2.0:
- 2.0/index.md
Reference in New Issue View Git Blame Copy Permalink