Skip to content

docs(cli): clarify AGENTS_DIR subdirectory behavior in adk web help #6181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vaibhav-patel wants to merge 2 commits into
base: main
Choose a base branch
from
+11 −7
Open

docs(cli): clarify AGENTS_DIR subdirectory behavior in adk web help #6181

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77ae61d
docs(cli): clarify AGENTS_DIR subdirectory behavior in adk web help
vaibhav-patel Jun 22, 2026
4cbbbc9
chore: re-trigger CI checks
vaibhav-patel Jun 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions src/google/adk/cli/cli_tools_click.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1805,9 +1805,11 @@ def cli_web(
):
"""Starts a FastAPI server with Web UI for agents.

AGENTS_DIR: The directory of agents (where each subdirectory is a single
agent containing `agent.py` or `root_agent.yaml` files) or a path pointing
directly to a single agent folder.
AGENTS_DIR: The directory containing your agents, or a path pointing directly
to a single agent folder. Each subdirectory is treated as a candidate agent
and is expected to contain an `agent.py` (or `__init__.py`) or a
`root_agent.yaml` file. All non-hidden subdirectories are listed; any that are
not valid agents are skipped when they fail to load.

Example:

Expand Down Expand Up @@ -1876,7 +1878,7 @@ async def _lifespan(app: FastAPI):

@main.command("api_server")
@feature_options()
# The directory of agents, where each subdirectory is a single agent.
# The directory containing your agents; each subdirectory is a candidate agent.
# By default, it is the current working directory
@click.argument(
"agents_dir",
Expand Down Expand Up @@ -1946,9 +1948,11 @@ def cli_api_server(
):
"""Starts a FastAPI server for agents.

AGENTS_DIR: The directory of agents (where each subdirectory is a single
agent containing `agent.py` or `root_agent.yaml` files) or a path pointing
directly to a single agent folder.
AGENTS_DIR: The directory containing your agents, or a path pointing directly
to a single agent folder. Each subdirectory is treated as a candidate agent
and is expected to contain an `agent.py` (or `__init__.py`) or a
`root_agent.yaml` file. All non-hidden subdirectories are listed; any that are
not valid agents are skipped when they fail to load.

Example:

Expand Down