Quickstart

Get from clone to a gridworld episode in under two minutes.

Install

From a clone (recommended for development):

git clone https://github.com/Alphabetsoup16/Flock.git flock && cd flock
./install.sh
export PATH="$PWD/target/release:$PATH"

One-liner (release binary):

curl -fsSL https://raw.githubusercontent.com/Alphabetsoup16/Flock/main/install.sh | bash

Or with Cargo directly:

cargo install --path crates/flock-cli

Requires stable Rust from rustup.rs; toolchain pinned in rust-toolchain.toml.

First success

flock run --goal "reach target" --plugin gridworld

Structured JSON appears on stdout; an episode file lands under .flock/episodes/.

Common commands

flock --help
flock run --goal "reach target" --plugin gridworld
flock run --goal "reach target" --plugin gridworld --rlm
flock evolve --episodes 16 --workspace .flock/episodes
flock replay --episode .flock/episodes/<goal-id>.json
flock replay --episode .flock/episodes/<goal-id>.json --continue-run
flock multiplexer ensure
flock dashboard          # ratatui control tower (daily driver)
flock herd status
flock drift-check
flock plugin list
flock mcp

MCP server

flock mcp

Wire your MCP client to the stdio JSON-RPC surface. Tool catalog: MCP tools.

Remote multiplexer

flock remote --goal "reach target" --plugin gridworld
flock remote --ssh user@host --goal "reach target" --plugin gridworld
flock remote --stub --goal "reach target"

Default socket: ~/.config/flock/flock.sock (override with FLOCK_SOCKET).

Verify before you PR

./scripts/verify.sh