Files
dev/docs/install.md
T
zeekay 806a7c93e7 feat: comprehensive upstream sync and hanzo branding updates
- Merged latest from OpenAI Codex upstream (reasoning effort tracking, apply-patch stability)
- Updated branding from 'Codex' to 'Hanzo Dev' throughout codebase
- Fixed compilation issues in TUI and core modules
- Enhanced build system with hanzo-crypto integration
- Preserved Hanzo identity while maintaining upstream compatibility
- Updated CLI tooling and MCP protocol implementations
- Added comprehensive GitHub Actions integration
2026-01-14 14:54:24 -08:00

35 lines
1.3 KiB
Markdown

## Installing & building
### System requirements
| Requirement | Details |
| --------------------------- | --------------------------------------------------------------- |
| Operating systems | macOS 12+, Ubuntu 20.04+/Debian 10+, or Windows 11 **via WSL2** |
| Git (optional, recommended) | 2.23+ for built-in PR helpers |
| RAM | 4-GB minimum (8-GB recommended) |
### DotSlash
GitHub Releases also contain a [DotSlash](https://dotslash-cli.com/) shim named `dev`. Checking the DotSlash file into your repo pins contributors to the same binary across platforms.
### Build from source
```bash
# Clone the repository and navigate to the workspace root.
git clone https://github.com/hanzoai/dev.git
cd dev
# Install the Rust toolchain, if necessary.
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
source "$HOME/.cargo/env"
# Build everything (CLI, TUI, MCP servers). This is the same check CI runs.
./build-fast.sh
# Launch the TUI with a sample prompt.
./target/debug/dev -- "explain this codebase to me"
```
> [!NOTE]
> The project treats compiler warnings as errors. The only required local check is `./build-fast.sh`; skip `rustfmt`/`clippy` unless asked.