Skip to content

Installation

Requirements

RequirementVersionNotes
Python3.12+Required
Docker20.10+Required for sandbox tools
uvLatestRecommended package manager

Install from Source

  1. Clone the repository

    Terminal window
    git clone https://github.com/dcramer/ash.git
    cd ash
  2. Install dependencies

    Terminal window
    uv sync --all-groups
  3. Verify CLI

    Terminal window
    uv run ash --help

Bootstrap Configuration

Create a starter config:

Terminal window
uv run ash init

By default this writes ~/.ash/config.toml (or $ASH_HOME/config.toml when ASH_HOME is set).

Inspect what is currently configured:

Terminal window
uv run ash config show

Validate config:

Terminal window
uv run ash config validate

Authenticate with OpenAI OAuth:

Terminal window
uv run ash auth login

Use openai-oauth providers in your model aliases:

[models.default]
provider = "openai-oauth"
model = "gpt-5.2"
[models.codex]
provider = "openai-oauth"
model = "gpt-5.2-codex"

Check auth status:

Terminal window
uv run ash auth status

Alternative Auth Path (API Key)

[openai]
api_key = "sk-..."
[models.default]
provider = "openai"
model = "gpt-5.2"

Run Upgrade (Builds Sandbox)

Terminal window
uv run ash upgrade

If you need to rebuild sandbox artifacts manually:

Terminal window
uv run ash sandbox build

Start Chat

Terminal window
uv run ash chat

Uninstall / Cleanup

For full removal (service, sandbox artifacts, Ash data, and optional install cleanup), see:

Troubleshooting

Config not found

Run:

Terminal window
uv run ash init

OAuth missing

Run:

Terminal window
uv run ash auth login

Docker unavailable

Check:

Terminal window
docker info