CLI overview

Create, develop, and deploy agents from your terminal with the ast CLI
View as Markdown

The Astro AI CLI (ast) is the primary tool for working with agents locally and publishing them to the Astro AI platform. It handles creating agent harnesses, local development, building containers, deploying to the registry, and managing running agents.

Installation

See Install the CLI for platform-specific installation instructions.

Verify your installation:

$ast --version

Configuration file

Most commands read astropods.yml in the current directory. This file defines your agent’s spec: its name, interface, models, tools, knowledge bases, and other configuration.

Global flags

These flags are available on all commands:

FlagShortDescription
--verbose-vVerbose output
--quiet-qMinimal output
--versionPrint the CLI version
--help-hHelp for the current command

Workflow overview

A typical workflow from zero to a deployed agent:

  1. ast project create: create a new agent harness
  2. ast project configure: set required credentials and variables
  3. ast project start: run the agent locally with hot-reload
  4. ast spec validate: check astropods.yml for errors
  5. ast push: build and push a blueprint to the registry
  6. ast blueprint deploy: deploy the blueprint as a live hosted agent

Authentication is handled separately with ast login.

Command groups

GroupDescription
ast projectLocal development: create, configure, start, stop, logs
ast blueprintRegistry: push, deploy, list, get
ast agentRunning agents: list, pause, resume, logs, redeploy, delete
ast secretsAccount vault: create, list, update, delete, import
ast accountAccount management: list, switch
ast specSpec tools: validate, explain
ast settingsCLI settings: telemetry, shell completions

Next steps