▋
tools/create-clankie/README.md

create-clankie

The Clankie bootstrapper. It has two entry points:

  • create-clankie <dir> clones the public Clankie checkout and runs the root installer (scripts/install.sh), so one command delivers the full product: the clankie CLI, the clankie-agent brain, and clankie-herdr.
  • create-clankie --protocol skips the product checkout and exports only the Clankie protocol skills plus a paste-ready AGENTS.md block.

The package is ready for public npm publication after the repository license is chosen and the release owner runs npm publish.

Full Product Install

npx create-clankie clankie
cd clankie
clankie up

Run the installer against an existing checkout instead of cloning:

npx --yes ./tools/create-clankie --use-existing .

Protocol-Only Install

Install the five protocol skills (herdr, clankie-lead, clankie-worker, clankie-consultant, clankie-work-tracker) into the Claude, Agents, and Codex skill roots, then print the repository AGENTS.md block to paste:

npx create-clankie --protocol

The protocol renderer reads the same behavior-policy environment variables the full product uses:

CLANKIE_POLICY_PR_ONLY=1 npx create-clankie --protocol
CLANKIE_POLICY_MERGE_AUTHORITY=human npx create-clankie --protocol

Re-run the command to re-render generated skill dirs. Remove only generated protocol dirs with:

npx create-clankie --protocol-uninstall

Options

create-clankie [dir] [options] [-- installer-options]
create-clankie --protocol [protocol-options]

  --repo <url>      Git repo to clone (default: CLANKIE_INSTALL_REPO or the public repo).
  --branch <name>   Branch/ref to clone.
  --use-existing    Install into an existing checkout instead of cloning.
  -h, --help        Show help.

Protocol options:
  --protocol                    Install protocol skills and print the AGENTS.md block.
  --protocol-uninstall          Remove protocol skills generated by this installer.
  --protocol-force              Replace existing protocol-generated skill dirs.
  --protocol-with-clankie-cli   Render Tier 3 helper text that uses the clankie CLI.
  --protocol-skill-root <dir>   Install into a specific skill root; repeat as needed.
  --policy <name>               direct, autonomous, or approval.
  --policy-pr-only <on|off>
  --policy-merge-authority <auto|human>
  --policy-design-gate <on|off>
  --policy-pr-granularity <per_issue|per_batch|per_epic|unset>

The clone source defaults to https://github.com/Volpestyle/clankie.git. Override it when testing a mirror or fork:

CLANKIE_INSTALL_REPO=https://github.com/you/clankie.git npx --yes ./tools/create-clankie clankie

Arguments after -- pass through to scripts/install.sh (e.g. --with-clankvox, --supervisor, --force):

npx --yes ./tools/create-clankie clankie -- --with-clankvox

Requirements

Node >= 24 (enforced here and by the installer), plus the installer's own prerequisites for the full product path (git, pnpm/corepack, Xcode CLT on macOS, and a Rust toolchain). Protocol-only install requires Node and writable skill roots.

The full install guide — prerequisites, what the installer does, flags, first run, and troubleshooting — is docs/install.md.