Quickstart

Build

git clone https://github.com/eikarna/hermes-rs.git
cd hermes-rs
cargo build --release

The binary lands at target/release/kerux.

Configure

Copy the example config and fill in your provider:

cp kerux.example.toml ~/.config/kerux/kerux.toml

Minimal config:

[client]
provider = "openai"
model = "gpt-4o"

[client.auth]
api_key_env = "OPENAI_API_KEY"

Or use environment variables directly:

export KERUX_PROVIDER=openai
export KERUX_MODEL=gpt-4o
export OPENAI_API_KEY=***

Run

Interactive TUI:

kerux

Single-shot:

kerux run "explain this codebase"

Gateway mode (Telegram + WhatsApp):

kerux serve

Verify

cargo fmt --all
cargo test --workspace
cargo clippy --workspace --all-targets --all-features -- -D warnings