Skip to content

Installation

Codive can be installed on macOS, Linux, and Windows. Choose your preferred installation method below.

If you have Rust installed, the easiest way to install Codive is via Cargo:

Terminal window
cargo install codive

This installs the latest stable version from crates.io.

  1. Clone the repository

    Terminal window
    git clone https://github.com/toliaqat/codive.git
    cd codive
  2. Build with Cargo

    Terminal window
    cargo build --release
  3. Install the binary

    Terminal window
    cargo install --path crates/agent-cli
  • Rust 1.75+ (if building from source)
  • Operating System: macOS 12+, Ubuntu 20.04+, Windows 10+
  • Architecture: x86_64 or ARM64

Codive requires an API key from an LLM provider. Currently supported:

ProviderEnvironment VariableGet API Key
AnthropicANTHROPIC_API_KEYconsole.anthropic.com
OpenAIOPENAI_API_KEYplatform.openai.com

Set your API key in your shell:

Terminal window
# For Anthropic Claude (recommended)
export ANTHROPIC_API_KEY="sk-ant-..."
# For OpenAI GPT-4
export OPENAI_API_KEY="sk-..."

After installation, verify Codive is working:

Terminal window
codive --version

You should see output like:

codive 0.1.0

Codive looks for configuration in the following locations (in order):

  1. ./codive.toml (project-specific)
  2. ~/.config/codive/config.toml (user config)
  3. Environment variables

Example configuration file:

~/.config/codive/config.toml
[provider]
name = "anthropic"
model = "claude-sonnet-4-20250514"
[agent]
max_iterations = 50
confirm_writes = true
[tools]
enabled = ["read", "write", "bash", "glob", "grep"]

To update Codive to the latest version:

Terminal window
cargo install codive --force

If codive is not found after installation, ensure the install directory is in your PATH:

Terminal window
# For Cargo installs
export PATH="$HOME/.cargo/bin:$PATH"
# For script installs
export PATH="$HOME/.local/bin:$PATH"

If you get authentication errors:

  1. Verify your API key is set: echo $ANTHROPIC_API_KEY
  2. Check the key is valid at your provider’s dashboard
  3. Ensure there are no extra spaces or quotes around the key

On Linux/macOS, you may need to make the binary executable:

Terminal window
chmod +x ~/.local/bin/codive

Now that Codive is installed, continue to the Quick Start guide to learn the basics.