quickstart

Get up and running with Andromity in under 5 minutes.

• Python 3.11+ (for executing the agent environment)
• pipx (recommended for global installation of CLI applications)
• An API Key (from Anthropic, OpenAI, Gemini, Groq, or OpenRouter) or a local Ollama server running

The simplest way is using our one-line global installation scripts.

Linux / macOS:

curl -fsSL https://raw.githubusercontent.com/agenticmarket/andromity/main/install.sh | bash

Windows (PowerShell):

irm https://raw.githubusercontent.com/agenticmarket/andromity/main/install.ps1 | iex

The scripts auto-install pipx if it is missing, download the latest version of Andromity, and update your environment path.

If you prefer to install it manually:

pipx install andromity

Don't have pipx installed? Get it via pip: pip install pipx && pipx ensurepath, then restart your terminal.

Andromity reads API keys from your environment variables. Export your key depending on the model provider you wish to use:

# For Anthropic Claude models
export ANTHROPIC_API_KEY="sk-ant-..."

# For Google Gemini models
export GEMINI_API_KEY="AIzaSy..."

# For OpenAI models
export OPENAI_API_KEY="sk-..."

# For OpenRouter access
export OPENROUTER_API_KEY="sk-or-..."

(Alternatively, you can write these keys directly into Andromity's automatic config file. See the Configuration Guide for config.toml setup).

Open a terminal inside your target software project directory and run:

andromity

This will launch Andromity's rich interactive TUI, ready to assist.

If you want to invoke Andromity for a single instruction without launching the interactive UI, use the run command:

andromity run "refactor this module to use async"

To run without requiring approvals for safe commands:

andromity run "write tests for user.py" --yes

To perform a dry run and preview proposed edits only:

andromity run "add error handling to main.py" --dry-run