Skip to main content
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.
Rye captures model traffic and local session telemetry. Treat local Rye logs and exported history as sensitive data.

​
Get started

1

Install Rye

Install the rye CLI and ryed daemon.
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.
2

Authenticate

Sign in with device-code auth.
Rye prints a browser link. Complete login in the browser, then return to your terminal.
3

Start the local proxy

Start Rye with HTTPS interception enabled.
By default, Rye listens on 127.0.0.1:18080 and intercepts common AI tool and model-provider domains.
4

Check setup

Verify auth, daemon state, proxy routing, CA trust, gRPC upload, and app shim setup.
5

Run a supervised session

Wrap one agent invocation.
Or run Codex CLI:
The wrapper injects proxy settings, keeps the terminal interactive, records session lifecycle events, watches file changes, and captures approval events when possible.
6

Inspect captured traffic

Review recent model traffic.
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.

​
Stop Rye

Stop the proxy and restore proxy settings that Rye configured:
Need help? Email security@rye.ai.