Skip to content

CLI reference

The PolyAI ADK is accessed through the poly command. Use the CLI help output as the first source of truth.

Start with help

To see all available commands and options:

poly --help

Each command also supports its own help output. For example:

poly push --help

Use help output as the source of truth

The installed CLI is the fastest way to confirm the commands and flags available in your local environment.

Core commands

poly init

Initialize a new Agent Studio project locally.

Examples:

poly init
poly init --region us-1 --account_id 123 --project_id my_project
poly init --base-path /path/to/projects
poly init --format

poly pull

Pull the latest project configuration from Agent Studio.

Examples:

poly pull
poly pull --force
poly pull --format

poly push

Push local changes to Agent Studio.

Examples:

poly push
poly push --dry-run
poly push --skip-validation
poly push --force
poly push --format

poly status

View changed, new, and deleted files in your project.

poly status

poly diff

Show differences between the local project and the remote version.

Examples:

poly diff
poly diff file1.yaml

poly revert

Revert local changes.

Examples:

poly revert --all
poly revert file1.yaml file2.yaml

poly branch

Manage project branches.

Examples:

poly branch list
poly branch current
poly branch create my-feature
poly branch switch my-feature
poly branch switch my-feature --force

poly format

Format project resources.

Examples:

poly format
poly format file1.py

poly validate

Validate project configuration locally.

poly validate

poly review

Create a GitHub gist for reviewing changes.

Examples:

poly review
poly review --before main --after feature-branch
poly review --delete

poly chat

Start an interactive chat session with your agent.

Examples:

poly chat
poly chat --environment live
poly chat --channel webchat
poly chat --metadata

poly docs

Output resource documentation.

Examples:

poly docs flows functions topics
poly docs --all

Working pattern

A typical CLI workflow looks like this:

  1. initialize or pull a project locally
  2. create or switch to a branch
  3. edit files
  4. inspect changes with poly status and poly diff
  5. validate with poly validate
  6. push with poly push
  7. optionally review with poly review
  8. test or chat with the agent using poly chat

Run commands from the project folder

ADK commands are expected to be run from within your local project directory. If needed, use the --path flag to point to a project explicitly.