Skip to content
Ash

Quick Start

Prerequisites

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

Use OpenAI OAuth if you have ChatGPT Plus/Pro. This avoids storing an OpenAI API key in config.

  1. Install dependencies

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

  2. Create config

    Terminal window
    uv run ash init

  3. Authenticate with OAuth

    Terminal window
    uv run ash auth login

  4. Run first-time upgrade checks

    Terminal window
    uv run ash upgrade

  5. Start chatting

    Terminal window
    uv run ash chat

Minimal OAuth Config Example

ash init generates a starter config at ~/.ash/config.toml (or $ASH_HOME/config.toml if ASH_HOME is set).

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


[models.fast]
provider = "openai-oauth"
model = "gpt-5.2-mini"


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

Alternative: API Key Setup

If you prefer API keys instead of OAuth:

[openai]
api_key = "sk-..."


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

Next Steps