Skip to content
Apothem
CLI reference

update

CLI reference for the apothem update command.

Re-install a harness adapter configuration from the current shared profile.

Synopsis

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

update re-materializes harness output from the current shared profile. It uses the same profile validation, --harness all selection, project-scope checking, dry-run behavior, and JSON envelope as install.

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

Options

OptionDescription
--harness NAMEHarness adapter to update, or all for the registry-wide set (required).
--profile PATHPath to shared profile YAML. Defaults to ~/.config/apothem/profile.yaml.
--dry-runPreview update without writing files.
--project PATHProject root for project-scope harnesses. Required when the selected harness set includes project-scope adapters.
--quiet, -qSuppress informational output; only errors are emitted.
--verbose, -vEmit additional diagnostic output.
--format plain|jsonOutput format (default: plain).
--jsonShorthand for --format json.
--no-colorDisable ANSI color codes in output.
-h, --helpShow help and exit.

JSON output

{
  "status": "success",
  "command": "update",
  "action": "updated",
  "harness": "claude-code",
  "profile_path": "C:\\Users\\Example\\.config\\apothem\\profile.yaml",
  "project": null,
  "files_written": [],
  "results": [],
  "warnings": [],
  "error": null,
  "output_path": "C:\\Users\\Example\\.claude\\settings.json"
}

--dry-run returns status: "dry_run" and files_written: [].

Examples

apothem update --harness claude-code
apothem update --harness claude-code --dry-run
apothem update --harness all --project . --dry-run --json
apothem Updating --harness claude-code   # continuous-form alias
apothem updating --harness claude-code   # lowercase variant

Exit codes

CodeMeaning
0Adapter updated successfully or dry-run planned cleanly
1Expected validation, profile, harness, project, or adapter error
2Partial batch materialization after at least one write

See also

  • apothem updating — continuous-form alias for this command (documented here; the CLI accepts both forms)
  • apothem install — initial install
  • Updating guide — per-installer update paths

On this page