Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Install

Get the flock binary on your machine and confirm the verify trio passes.

Install methods

MethodCommandBest for
Install scriptcurl -fsSL https://raw.githubusercontent.com/Alphabetsoup16/Flock/main/install.sh | bashQuick try / operators
From clonegit clone … && ./install.shDevelopment
Cargo pathcargo install --path crates/flock-cliRust contributors
Cargo release buildcargo build --release -p flock-cliCI / 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

GoalPage
First episode walkthroughQuickstart
Multiplexer daily loopDaily driver
Agent onboardingAgent guide