Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 5 additions & 3 deletions docs/docs/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: CLI reference
description: Reference for the core commands provided by the PolyAI ADK CLI.
---

# CLI reference

<p class="lead">
The PolyAI ADK is accessed through the <code>poly</code> command.
Use the CLI help output as the first source of truth.
Expand Down Expand Up @@ -166,8 +164,12 @@ Examples:
~~~bash
poly docs flows functions topics
poly docs --all
poly docs --all --output rules.md
~~~

Use `--output` to write the documentation to a local file. This is useful when working with AI coding tools — pass the output file as context to give the agent accurate knowledge of ADK resource types and conventions.


## Working pattern

A typical CLI workflow looks like this:
Expand Down Expand Up @@ -203,4 +205,4 @@ A typical CLI workflow looks like this:
Learn how to run tests for the project.
[Open testing](./testing.md)

</div>
</div>
10 changes: 10 additions & 0 deletions docs/docs/reference/tooling.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,16 @@ Claude Code is particularly useful for:
- applying patterns reused across previous projects
- speeding up repetitive implementation work

#### Loading ADK rules into your coding agent

Before using Claude Code or another AI coding tool, generate a local documentation file and reference it in your session:

~~~bash
poly docs --all --output rules.md
~~~

Then reference rules.md in your prompt or agent context. This gives your coding agent accurate knowledge of ADK resource types, constraints, and conventions.

### VS Code extension

A **PolyAI ADK VS Code extension** is available in the VS Code Marketplace:
Expand Down
18 changes: 13 additions & 5 deletions docs/docs/tutorials/build-an-agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,13 @@ poly docs flows functions topics

Resource-specific documentation is available for agent settings, voice settings, chat settings, flows, functions, topics, entities, handoffs, variants, SMS templates, variables, speech recognition, response control, and experimental config.

To write the output to a file for use with an AI coding tool, run:
~~~bash
poly docs --all --output rules.md
~~~bash

Reference `rules.md` in your coding agent context to give it accurate knowledge of ADK resource types and conventions.

### Step 5 — Customise the agent

This is the core build phase. Create a branch, edit resources locally, track changes, and push them back.
Expand Down Expand Up @@ -343,15 +350,16 @@ Now provide the coding agent with the information you gathered earlier.
This is the core input step. Include:

- project-specific requirements
- the URL to the businesss public API documentation
- the URL to the business's public API documentation
- relevant internal context
- useful patterns or best practices from previous projects

The coding agent can also use the docs command to inspect the SDK and understand the available resources.
Before starting, generate a local documentation file and reference it in your coding agent session. This gives the agent accurate knowledge of ADK resource types, schemas, and conventions.
```bash
poly docs --all --output rules.md
```

~~~bash
poly docs --all
~~~
Point your coding agent at `rules.md` as part of its initial context. The agent can then use it to generate and edit project files correctly without needing to run `poly docs` interactively.

Reusing proven patterns from earlier projects can improve both speed and output quality.

Expand Down
Loading