Documentation

CLI reference / Project

cumaru install

Install one domain from main HEAD and one agent adapter into the current project.

Synopsis

cumaru install [agent <none|claude|codex|opencode>] [--domain <name>]

Arguments and options

Argument or optionMeaning
agent <name>Materialize one native agent integration. Default: none.
--domain <name>Domain from main HEAD. Default: __base; base is an alias. List names with cumaru help domains.

Side effects

  • Writes: Creates .cumaru/ and the adapter artifacts: skills, instructions, and, for Claude and Codex, the hook file. Existing adapter files are merged, never overwritten.
  • Network: Reads the domain from GitHub main, pinned to one commit. Requires cURL.

Behavior

  • Refuses any existing .cumaru entry before network access. Use cumaru update for an existing tree.
  • Validates the remote config as version 9 and downloads everything before writing.
  • There is no transaction or rollback: an I/O failure after publication starts can leave a partial install.
  • It does not run doctor or bootstrap.

Example

cumaru install agent claude --domain sdlc-light

Failures

  • Fails before any write on an invalid domain or adapter, an existing .cumaru entry, or malformed adopter JSON or instruction blocks.

Sources: docs/install.md,Agent adapters; cumaru install --help of CLI 0.15.3.

Back to all commands