create-clanky

The Clanky bootstrapper. It clones a Clanky checkout and runs its root installer (scripts/install.sh), so one command delivers the whole product: the clanky CLI, the clanky-agent brain, and clanky-herdr — Clanky's bundled terminal multiplexer.

This package is intentionally private: true until Clanky has a public npm release path. Use the pre-public forms below.

Pre-public bring-up

Clone and install from the private Git repo without publishing to npm:

npx --yes --package git+ssh://git@github.com/Volpestyle/clanky-internal.git#master -- create-clanky clanky
cd clanky
clanky up

Run the installer against an existing checkout instead of cloning:

npx --yes ./packages/create-clanky --use-existing .

Options

create-clanky [dir] [options] [-- installer-options]

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

The clone source defaults to git@github.com:Volpestyle/clanky-internal.git. Override it when testing a mirror or fork:

CLANKY_INSTALL_REPO=git@github.com:Volpestyle/clanky-internal.git npx --yes ./packages/create-clanky clanky

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

npx --yes ./packages/create-clanky clanky -- --with-clankvox

Requirements

Node >= 24 (enforced here and by the installer), plus the installer's own prerequisites (pnpm/corepack, a Rust toolchain). The published npx create-clanky form is the intended new-user path once this package ships.

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