install — Apothem CLI¶

Install a harness adapter configuration from the shared profile.

Synopsis¶

apothem install --harness NAME [--profile PATH] [--dry-run]
                 [--quiet|-q] [--verbose|-v]
                 [--format plain|json] [--json] [--no-color]

Materialises the harness-native configuration file for the named adapter from the shared profile.

The continuous-form alias apothem installing resolves to the same handler.

Options¶

Option	Description
`--harness NAME`	Harness adapter to install (required). e.g. `claude-code`, `cursor`, `gemini-cli`.
`--profile PATH`	Path to shared profile YAML. Defaults to `~/.config/apothem/profile.yaml`.
`--dry-run`	Preview install without writing files.
`--quiet`, `-q`	Suppress informational output; only errors are emitted.
`--verbose`, `-v`	Emit additional diagnostic output.
`--format plain\\|json`	Output format (default: `plain`).
`--json`	Shorthand for `--format json`.
`--no-color`	Disable ANSI color codes in output.
`-h`, `--help`	Show help and exit.

JSON output¶

When --json (or --format json) is supplied, a single JSON document is written to stdout:

{
  "action": "installed",
  "harness": "claude-code",
  "output_path": "C:\\Users\\Gad\\.claude\\CLAUDE.md"
}

For --dry-run:

{
  "action": "dry_run",
  "verb": "install",
  "harness": "claude-code",
  "output_path": "..."
}

For stub adapters that have not yet implemented install():

{"error": "stub", "harness": "claude-code", "verb": "install"}

Examples¶

apothem install --harness claude-code
apothem install --harness claude-code --dry-run
apothem install --harness cursor --profile ~/profile.yaml --json
apothem Installing --harness claude-code   # continuous-form alias
apothem installing --harness claude-code   # lowercase variant

Exit codes¶

Code	Meaning
0	Adapter installed successfully
1	Harness not found, adapter stub, or adapter error