Skip to content

quickstart.md

Latest commit

 

History

History
67 lines (44 loc) · 2 KB

quickstart.md

File metadata and controls

67 lines (44 loc) · 2 KB

Quickstart

Install

Requires Rust 1.91+ (edition 2024).

cargo install --path crates/oxide-code

Set up credentials

oxide-code needs an Anthropic API credential. The simplest way is to set your API key:

export ANTHROPIC_API_KEY=sk-ant-...

Alternatively, if you have Claude Code installed and authenticated, oxide-code can use its OAuth credentials automatically. See Configuration for details.

Start a session

ox

This opens an interactive REPL. Type a task and press Enter:

> Read main.rs and explain the agent loop.

The assistant reads files, runs commands, and edits code using its built-in tools. It loops — calling tools and feeding results back — until it produces a final text response.

What it can do

oxide-code has six built-in tools:

Tool Purpose
bash Run shell commands
read Read files with line numbers
write Create or overwrite files
edit Replace exact strings in files
glob Find files by pattern
grep Search file contents with regex

The assistant decides which tools to use based on your request. You can guide it by being specific: "edit the function signature in src/lib.rs" is better than "fix the code".

Customize behavior

Drop a CLAUDE.md file in your project root to give the assistant project-specific instructions:

# CLAUDE.md

- Use snake_case for all function names.
- Run `cargo test` after making changes.
- Do not modify files in the `vendor/` directory.

See Instruction Files for the full discovery hierarchy.

Next steps

  • Configuration — API credentials, model selection, and all environment variables.
  • Instruction Files — discovery hierarchy, global vs. project scope, writing tips.