Documentation

CLI reference / Project

cumaru update

Preview or apply a same-version refresh of the project and its agent artifacts from main HEAD.

Synopsis

cumaru update [<path>|config|skills <agent>|commands <agent>|agent <agent>] [--prose|--skip-prose] [--skills] [--apply|--clear] [--with <skill>...]

Arguments and options

Argument or optionMeaning
<path>Limit the refresh to one content scope.
configPrint a read-only reconciliation candidate for config.yaml.
skills|commands|agent <agent>Address one adapter surface: none, claude, codex, or opencode.
--applyPublish the displayed refresh. Preview is the default.
--clearImmediately remove the selected owned adapter surface, without remote access.
--with <skill>Add or refresh one opt-in skill; repeatable in skills mode.
--proseRefresh canonical Markdown prose, preserving local tag bodies.
--skip-proseRefresh frontmatter and missing tag scaffolds, keeping local prose.
--skillsWith agent <agent>: refresh the complete integration, including instructions and hooks.

Side effects

  • Writes: Preview writes nothing. --apply publishes the shown plan and then warms the vector cache. --clear removes owned adapter files at once.
  • Network: Reads the matching domain from GitHub main, except --clear.

Behavior

  • Update never crosses a config version; use cumaru migrate for that.
  • --apply and --clear run a Git recovery check: pending changes block them. Outside Git, they warn and continue.
  • --apply and --clear are mutually exclusive.
  • Tag bodies are preserved byte for byte.

Example

cumaru update agent codex

Failures

  • Fails on a config version boundary, pending Git changes with --apply or --clear, or malformed tags before publication.

Sources: docs/update.md; cumaru update --help of CLI 0.15.3.

Back to all commands