Documentation

Install Andromity for VS Code and Terminal

Install the Andromity AI coding agent from the VS Code Marketplace, with pipx, or with the install script on Windows, macOS, and Linux, then verify the setup.

Andromity can be installed as a native VS Code extension, a standalone CLI/TUI application, or from source for development.

Prerequisites

Before installing Andromity, ensure your system meets the following requirements:

  • Python: >= 3.11 (Python 3.12 and 3.13 are fully supported)
  • Git: Installed and accessible in your system PATH
  • Operating Systems: macOS (Apple Silicon / Intel), Linux (x86_64 / arm64), Windows 10/11 (PowerShell & WSL2)
  • Node.js (Optional): >= 18.0.0 (required only if running custom TypeScript MCP servers)

1. VS Code Extension Installation

The VS Code extension provides the rich UI experience with Secondary Sidebar docking, interactive diff overlays, and the live waterfall profiler.

Marketplace Installation

  1. Open VS Code.
  2. Press Ctrl + P (or Cmd + P on macOS).
  3. Paste the following command and press Enter:
ext install agenticmarket.andromity-agent

CLI Extension Installation

If you prefer installing from terminal:

code --install-extension agenticmarket.andromity-agent

2. Standalone Terminal CLI Installation

The terminal runtime provides the raw engine with a terminal user interface (TUI) powered by Textual and Rich.

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

The installer automatically:

  • Verifies Python 3.11+ availability.
  • Creates an isolated virtual environment at ~/.andromity/venv.
  • Symlinks the andromity binary to /usr/local/bin or ~/.local/bin.

3. Verifying Installation

Verify that the CLI executable is available in your shell:

andromity --version

Start an interactive session:

andromity

Run a one-shot scripted command in headless mode:

andromity run "analyze git status and report pending changes" --dry-run

4. Platform-Specific Notes

Windows Store Python

If Python was installed via the Microsoft Store, Windows virtualizes local app data. Your configuration files will reside in:

%LOCALAPPDATA%\Packages\PythonSoftwareFoundation.Python.3.12_qbz5n2kfra8p0\LocalCache\Roaming\andromity\

For standard native Python or pyenv-win installations, files are stored at %APPDATA%\andromity\config.toml.

Linux Headless Servers

When running Andromity on remote servers via SSH, ensure your terminal supports 256-color or truecolor mode (export TERM=xterm-256color) for optimal Textual rendering.