Documentation

Guide

Customize

Cumaru separates framework prose from your content. This guide changes only the parts you own, so cumaru update can still refresh the rest.

1. Record project context

Put local facts inside tag bodies, never in the framework prose around them. In most domains, project context goes in the root tag of domain.md:

cumaru tag get domain.md root

Write it with cumaru tag set domain.md root, using positional content or stdin.

2. Declare targets

The targets: field in frontmatter takes values from meta.targets.values in .cumaru/config.yaml. The meaning depends on the domain: components in sdlc, environments in iac-basic, test levels in qa-basic, packages in homebrew-management.

3. Add a custom area

Create the directory and its index with the guarded CLI, then give the index a summary:

cumaru fs specs/billing/index.md create

A new pillar must also be declared in config.yaml under root. Run cumaru doctor after every structural change.

4. Apply a discipline to one file

Disciplines in .cumaru/disciplines/ load at every session start. To apply one to a single file, invoke the cumaru-discipline skill. It is an agent skill, not a CLI command:

$cumaru-discipline solid src/billing/invoice.ts

To turn an external skill into a local discipline with attribution, install the opt-in skill-to-discipline skill (see Skills).

5. Define a named workflow

workflows in config.yaml declares steps by installed skill and their dependencies:

workflows:
  release:
    steps:
      specs:
        skill: cumaru-specs
      refs:
        skill: cumaru-refs
        needs: [specs]

Run it with the cumaru-flow skill and the workflow name. It runs doctor first, follows needs, and stops on any failure or required input. Doctor rejects cycles and steps whose skill is not installed.

Sources: config schema, tag, fs, cumaru-discipline, cumaru-flow. The billing and release names are illustrations.