Skip to content

Kerux

CI Documentation Release License

κῆρυξ — a fast, self-contained Rust agent for LLM-driven tool execution.
Streaming-first ReAct loop · ratatui TUI · Telegram & WhatsApp gateway · autonomous coding mode


Kerux workspace

Highlights

  • Streaming-first ReAct loop — tool calls detected and executed incrementally from partial LLM output, with a tolerant XML parser and self-healing re-prompts on failure
  • Ratatui TUI — prompt-first landing screen, responsive workspace panes, reasoning rails, tool activity blocks, MCP/Skills/Behavior management
  • Messaging gateway (kerux serve) — Telegram long-polling + WhatsApp bridge, MarkdownV2 conversion, live status edits, SSE streaming replies, tool approval via inline keyboard, voice-note STT, cron scheduler, subagent delegation
  • Autonomous coding mode — 24/7 loop that reads TODO.md, validates with local tests, and only pushes after success
  • Persistent state — sessions, memory, todos, and cron jobs survive restarts (atomic JSON writes under ~/.kerux/)
  • Repo-map context — tree-sitter symbols + personalized PageRank, token-budgeted into the system prompt
  • Transactional git harness — pre-run snapshots, Conventional Commits, TUI /undo

Install

cargo install --path crates/kerux-cli
# or grab a prebuilt binary from GitHub Releases

Quick start

export OPENAI_API_KEY=***        # or: kerux auth login nous (OAuth, no key needed)

kerux chat                        # prompt-first TUI
kerux run --query "What is 2+2?"  # one-shot
kerux serve                       # Telegram/WhatsApp gateway
kerux autonomous                  # 24/7 coding loop

Documentation

Full docs live at kerux.eikarna.dev — built with mdBook and refreshed automatically on every push:

Quickstart Build, configure, first run
Configuration TOML schema, env vars, auth profiles
Architecture Agent loop, streaming, tools
Gateway & Adapters Telegram & WhatsApp
Features Approval, compaction, fallbacks, STT, cron, delegation
Roadmap What's next

Screenshots in this README and the docs are generated automatically by CI (kerux screenshot renders the TUI headlessly) whenever the UI changes.

Development

cargo build --workspace
cargo test --workspace     # 423 tests
cargo fmt --all && cargo clippy --workspace --all-targets -- -D warnings

See CONTRIBUTING.md for conventions and the PR process.

Credits

A pure-Rust rewrite of the Hermes-Agent orchestration loop by Nous Research. Unofficial community port — not affiliated with or endorsed by Nous Research.

License

Dual-licensed under MIT or Apache-2.0.

About

A high-performance Rust implementation orchestration loop for LLM-driven tool execution.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

66 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages