Documentation for using oxide-code (ox).
| Document | Description |
|---|---|
| Installation | Requirements, prebuilt binary, Homebrew, Cargo, Nix, verify / update / uninstall |
| Quickstart | Credentials, first session, tool approval, instruction files |
| Authentication | Credential sources, browser sign-in, fixed credentials, LLM gateways |
| Terminal UI | Input keys, queued prompts, interrupting and exiting, scrolling, selecting and copying |
| Configuration | Layered config, models, compaction, TUI settings, themes, TLS, environment, logs |
| Permissions | Permission modes, the approval prompt, pattern cookbook, built-in rules, workspace roots, the environment commands run in |
| Slash Commands | Built-in client-side commands and autocomplete |
| Instruction Files | AGENTS.md / CLAUDE.md setup and discovery rules |
| Sessions | Storage, listing, resume, titles, deletion, archiving, security |
| Headless Mode | One-shot -p runs, output formats, exit status, the JSON result and event schema, the bare REPL |
| Theming | Built-in palettes, custom themes, slot overrides |