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:

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

Or with pnpm:

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

Or with yarn:

yarn global add @astreus-ai/astreus-cli

Run Without Installing

You can also run directly with npx:

npx @astreus-ai/astreus-cli

Quick Start

1. Set up your API key:

export OPENAI_API_KEY=your-api-key

2. Start the CLI:

astreus

3. Start chatting with your AI agent!

Usage Options

# 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:

astreus --version

Next Steps

• Commands - Learn all available commands
• Providers - Configure different LLM providers
• Configuration - Set up environment variables