Prerequisites
Make sure the following are in place before building.-
Rust toolchain (stable) — Install via rustup:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh. Hiroshi requires the stable channel and the 2024 edition, which is included in Rust 1.85 and later. -
Ollama — Download and install from ollama.ai, then start the server with
ollama serve. -
A compatible model — Pull at least one model before launching Hiroshi. The default recommended model is:
You can also use larger models such as
qwen2.5-coder:7borllama3. The onboarding wizard scans for locally available models and lets you choose. -
Embedding model — Hiroshi uses
nomic-embed-textfor memory embeddings by default. Pull it with:
Build from source
Build in release mode
Compile a fully optimised binary. The release profile enables LTO, sets The binary is written to
opt-level = 3, strips debug symbols, and uses a single codegen unit — the resulting binary is compact and fast.target/release/Hiroshi (or target/release/Hiroshi.exe on Windows).Install to PATH (optional)
Install the binary into your Cargo bin directory (
~/.cargo/bin) so you can run hiroshi from anywhere.Feature flags
Hiroshi uses Cargo feature flags to control which optional components are compiled in. This lets you produce a smaller, faster binary if you don’t need chat gateways or the web dashboard.| Feature | What it enables | Dependencies |
|---|---|---|
gateway-ui | Local web dashboard served on port 8080 via Axum | axum, tower-http |
channel-telegram | Telegram bot gateway | None (uses core reqwest) |
channel-discord | Discord WebSocket gateway | tokio-tungstenite |
channel-slack | Slack Socket Mode gateway | tokio-tungstenite |
kernel-only | Strips all channels and the UI — agent loop only | None |
gateway-ui, channel-telegram, channel-discord, and channel-slack.
To build a minimal kernel-only binary without any gateways or dashboard:
First-time setup
When you run any Hiroshi command for the first time, Hiroshi detects that~/.hiroshi/config.toml does not exist and automatically launches the interactive onboarding wizard. The wizard creates the full ~/.hiroshi/ directory structure — including the SQLite database, the skills/ directory pre-populated with bundled skills, and the default AGENTS.md — and writes your choices to config.toml.
You do not need to create any configuration files manually. Simply run hiroshi agent and follow the prompts.