Skip to content

Quick Start

Get Ash up and running with these steps.

Prerequisites

  • Python 3.12+
  • uv package manager
  • Docker (for sandboxed command execution)

API Keys Required:

  • Anthropic — Powers the LLM (Claude)
  • OpenAI — Powers memory embeddings

Installation

  1. Clone and install

    Terminal window
    git clone https://github.com/dcramer/ash.git
    cd ash
    uv sync --all-groups
  2. Configure

    Terminal window
    uv run ash init

    This creates ~/.ash/config.toml with a template. Edit it to add your API keys.

  3. Build the sandbox

    Terminal window
    uv run ash sandbox build
  4. Initialize the database

    Terminal window
    uv run ash upgrade

Start Chatting

Terminal window
uv run ash chat

Or run a single prompt:

Terminal window
uv run ash chat "Find all TODO comments in my codebase"

Run as a Server

For Telegram integration or API access:

Terminal window
uv run ash serve

Runs on http://127.0.0.1:8080 by default.

Next Steps