Skip to main content

Getting Started

Prerequisites​

  • Nix with flakes enabled (recommended)
  • Or: Rust toolchain (cargo, rustc)

Installation​

With Nix​

# Enter the development environment
nix develop

# Build the project
cargo build --release

# Run it
cargo run --release

Without Nix​

Make sure you have Rust installed, then:

cargo build --release
cargo run --release

Usage​

Navigate to a git repository and run:

hunky

# or during development:
cargo run

# Specify a different repository:
hunky --repo /path/to/repo

Try the Demo​

In a separate terminal, start the simulation script:

./simulation.sh

Then build and run:

cargo run -- --repo test-repo

The simulation will continuously make file changes that Hunky will detect and display automatically!