Installation

Get Astreus CLI up and running in minutes. The CLI is your AI-powered assistant for building agents with the Astreus framework.

Requirements#

  • Node.js >= 22.0.0
  • One of the supported LLM provider API keys
  • Familiarity with the Astreus framework

Install Globally#

Install Astreus CLI globally using npm:

bash
npm install -g @astreus-ai/astreus-cli

Or with pnpm:

bash
pnpm add -g @astreus-ai/astreus-cli

Or with yarn:

bash
yarn global add @astreus-ai/astreus-cli

Run Without Installing#

You can also run directly with npx:

bash
npx @astreus-ai/astreus-cli

Quick Start#

  1. Set up your API key:
bash
export OPENAI_API_KEY=your-api-key
  1. Start the CLI:
bash
astreus
  1. Start chatting with your AI agent!

Usage Options#

bash
# Start the interactive CLI
astreus

# Start with a specific provider via environment variable
ASTREUS_PROVIDER=claude astreus

# Start with a specific model via environment variable
ASTREUS_MODEL=gpt-4o astreus

# Combine provider and model
ASTREUS_PROVIDER=claude ASTREUS_MODEL=claude-sonnet-4-20250514 astreus

Verify Installation#

Check that Astreus CLI is installed correctly:

bash
astreus --version

Next Steps#