Skip to content

QUICKSTART.md

Latest commit

Β 

History

History
73 lines (52 loc) Β· 1.13 KB

QUICKSTART.md

File metadata and controls

73 lines (52 loc) Β· 1.13 KB
Raw

RustCode Quickstart

Build

cargo build --release

Install

cargo install --path .

Verify

rustcode --help
rustcode --version

Configure a provider

First run:

rustcode

This opens the full-screen TUI and automatically starts onboarding if configuration is incomplete.

Interactive onboarding:

rustcode config onboard

Manual commands:

rustcode config set provider deepseek
rustcode config set api_key "your-api-key"
rustcode config set model deepseek-chat

Configure a custom provider

rustcode config set provider custom
rustcode config set protocol openai
rustcode config set custom_provider_name my-gateway
rustcode config set base_url https://api.example.com
rustcode config set model custom-model

Enable fallback

rustcode config set fallback.enabled true
rustcode config set fallback.chain "deepseek:deepseek-chat,openai:gpt-4.1-mini"

Run

rustcode query --prompt "Hello"
rustcode
rustcode tui
rustcode repl

rustcode and rustcode tui use the new full-screen TUI. rustcode repl keeps the legacy line-based REPL.