Install
Get the flock binary on your machine and confirm the verify trio passes.
Install methods
| Method | Command | Best for |
|---|---|---|
| Install script | curl -fsSL https://raw.githubusercontent.com/Alphabetsoup16/Flock/main/install.sh | bash | Quick try / operators |
| From clone | git clone … && ./install.sh | Development |
| Cargo path | cargo install --path crates/flock-cli | Rust contributors |
| Cargo release build | cargo build --release -p flock-cli | CI / local dev |
Requires stable Rust from rustup.rs; toolchain pinned in rust-toolchain.toml.
After install script or release build, ensure flock is on PATH:
export PATH="$PWD/target/release:$PATH" # from repo root
Verify trio
Run these three commands after install — all should succeed:
flock --version
flock run --goal "reach target" --plugin gridworld
flock doctor
Episode JSON appears under .flock/episodes/. For full CI parity, see Verify and ./scripts/verify.sh.
Optional: mdbook (docs contributors)
cargo install mdbook mdbook-mermaid --locked
mdbook build book
Next steps
| Goal | Page |
|---|---|
| First episode walkthrough | Quickstart |
| Multiplexer daily loop | Daily driver |
| Agent onboarding | Agent guide |