mirror of
https://github.com/hanzoai/dev.git
synced 2026-10-25 03:32:32 +00:00
VictorandGitHub
b2cb05d562
Update install and contributing guides to use the root justfile helpers (`just fmt`, `just fix -p <crate>`, and targeted tests) instead of the older cargo fmt/clippy/test instructions that have been in place since459363e17b. This matches the justfile relocation to the repo root in952d6c946and the current lint/test workflow for CI (see `.github/workflows/rust-ci.yml`).
1.3 KiB
1.3 KiB
Install & build
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 shim named code. Checking the DotSlash file into your repo pins contributors to the same binary across platforms.
Build from source
# Clone the repository and navigate to the workspace root.
git clone https://github.com/just-every/code.git
cd code
# 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/code -- "explain this codebase to me"
Note
The project treats compiler warnings as errors. The only required local check is
./build-fast.sh; skiprustfmt/clippyunless asked.