> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rye.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Install Rye and run your first supervised AI coding agent session.

This guide installs Rye on a developer workstation, authenticates the device, starts the local proxy, and runs one AI coding agent through Rye supervision.

## Prerequisites

* A macOS or Linux workstation.
* A Rye account.
* A supported AI coding CLI such as Claude Code or Codex CLI.
* Permission to install a local CA certificate if you want HTTPS interception.

<Warning>
  Rye captures model traffic and local session telemetry. Treat local Rye logs and exported history as sensitive data.
</Warning>

## Get started

<Steps>
  <Step title="Install Rye">
    Install the `rye` CLI and `ryed` daemon.

    ```bash theme={null}
    curl -fsSL https://storage.googleapis.com/barn.rye.ai/install.sh | sh
    ```

    The installer downloads versioned binaries, verifies checksums, installs shell completions, registers the daemon when the platform supports it, and adds app shims for `claude` and `codex` when those commands are present.

    ```bash theme={null}
    rye version
    ```
  </Step>

  <Step title="Authenticate">
    Sign in with device-code auth.

    ```bash theme={null}
    rye auth login
    ```

    Rye prints a browser link. Complete login in the browser, then return to your terminal.
  </Step>

  <Step title="Start the local proxy">
    Start Rye with HTTPS interception enabled.

    ```bash theme={null}
    rye up --install-ca
    ```

    By default, Rye listens on `127.0.0.1:18080` and intercepts common AI tool and model-provider domains.
  </Step>

  <Step title="Check setup">
    Verify auth, daemon state, proxy routing, CA trust, gRPC upload, and app shim setup.

    ```bash theme={null}
    rye status
    rye doctor
    ```
  </Step>

  <Step title="Run a supervised session">
    Wrap one agent invocation.

    ```bash theme={null}
    rye wrap claude
    ```

    Or run Codex CLI:

    ```bash theme={null}
    rye wrap codex
    ```

    The wrapper injects proxy settings, keeps the terminal interactive, records session lifecycle events, watches file changes, and captures approval events when possible.
  </Step>

  <Step title="Inspect captured traffic">
    Review recent model traffic.

    ```bash theme={null}
    rye history --last 10m
    rye history export --format json --last 10m
    ```
  </Step>
</Steps>

<Tip>
  The installer also sets up persistent shims when `claude` or `codex` are already installed. After restarting your shell, running `claude` or `codex` can route through Rye automatically. Use `rye app doctor` to verify PATH ordering.
</Tip>

## Stop Rye

Stop the proxy and restore proxy settings that Rye configured:

```bash theme={null}
rye down
```

Need help? Email [security@rye.ai](mailto:security@rye.ai).