Installation
Requirements
| Requirement | Version | Notes |
|---|---|---|
| Python | 3.12+ | Required |
| Docker | 20.10+ | Required for sandbox tools |
| uv | Latest | Recommended package manager |
Install from Source
-
Clone the repository
Terminal window git clone https://github.com/dcramer/ash.gitcd ash -
Install dependencies
Terminal window uv sync --all-groups -
Verify CLI
Terminal window uv run ash --help
Bootstrap Configuration
Create a starter config:
uv run ash initBy default this writes ~/.ash/config.toml (or $ASH_HOME/config.toml when ASH_HOME is set).
Inspect what is currently configured:
uv run ash config showValidate config:
uv run ash config validateRecommended Auth Path (OAuth)
Authenticate with OpenAI OAuth:
uv run ash auth loginUse 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:
uv run ash auth statusAlternative Auth Path (API Key)
[openai]api_key = "sk-..."
[models.default]provider = "openai"model = "gpt-5.2"Run Upgrade (Builds Sandbox)
uv run ash upgradeIf you need to rebuild sandbox artifacts manually:
uv run ash sandbox buildStart Chat
uv run ash chatUninstall / Cleanup
For full removal (service, sandbox artifacts, Ash data, and optional install cleanup), see:
Troubleshooting
Config not found
Run:
uv run ash initOAuth missing
Run:
uv run ash auth loginDocker unavailable
Check:
docker info