Skip to navigation

Install the CLI

Download and set up the ast CLI
View as Markdown

The Astropods CLI (ast) is used to create agents, run them locally, and push to the Astropods registry. Install it from your Astropods host (e.g. astropods.com).

By downloading, you agree to the Astropods Terms of Service and Privacy Policy.

Before you start

  • A supported operating system: macOS, Linux, or Windows.
  • curl available in your terminal (macOS and Linux), or PowerShell 5.1 or later (Windows).
  • sudo access (for the manual install, which writes to /usr/local/bin).

On macOS and Linux, run this in your terminal:

curl -fsSL https://astropods.com/install | sh

On Windows, run this in PowerShell:

irm https://astropods.com/install.ps1 | iex

Both installers verify the download against the published checksum, install to ~/.ast/bin, and add that directory to your PATH. On Windows, open a new terminal afterwards so the PATH change takes effect.

Replace the URL with your Astropods host if different. On macOS, if the binary is blocked, open Settings > Privacy & Security and click Allow for the downloaded file so it can run.

Manual install (macOS)

Get the binary for your architecture and install into /usr/local/bin:

macOS (Intel):

curl -fsSL https://astropods.com/download/ast-darwin-amd64 -o ast && chmod +x ast;
sudo mv ast /usr/local/bin/

macOS (Apple Silicon):

curl -fsSL https://astropods.com/download/ast-darwin-arm64 -o ast && chmod +x ast;
sudo mv ast /usr/local/bin/

Manual install (Windows)

Prefer the PowerShell installer above, which also verifies the checksum. To place the binary yourself, download the one for your architecture:

Windows (x64):

Invoke-WebRequest https://astropods.com/download/ast-windows-amd64.exe -OutFile ast.exe

Windows (Arm):

Invoke-WebRequest https://astropods.com/download/ast-windows-arm64.exe -OutFile ast.exe

Move ast.exe into a directory on your PATH, for example:

New-Item -ItemType Directory -Force "$env:LOCALAPPDATA\Astro\bin" | Out-Null
Move-Item -Force ast.exe "$env:LOCALAPPDATA\Astro\bin\ast.exe"
[Environment]::SetEnvironmentVariable(
"Path", "$env:Path;$env:LOCALAPPDATA\Astro\bin", "User")

Open a new terminal so the updated PATH takes effect.

Running agents locally on Windows

ast project start runs your agent in Docker containers, so Windows needs a way to reach a Docker daemon. Pick one:

Install Docker Desktop for Windows and start it. Grant it access to the drive your project lives on, under Settings > Resources > File sharing, or ast project start cannot mount your agent directory.

Run ast directly from PowerShell or Command Prompt, same as any other Windows CLI.

Verify installation

ast --version

You should see a version string like ast 1.2.3.

Keeping up to date

Upgrade to the latest CLI version at any time:

ast upgrade

Next steps

Run ast --help to see all available commands.