Skip to content

Reference ​

Facts about the commands, the configuration and the environment of noomoo, in the form of tables and short entries. For a first run, start with Quickstart.

Language ​

Two languages are supported, with English as the default: setup writes "language": "en" and English skeletons unless NOOMOO_LANGUAGE=ru is set, and then writes "language": "ru" and Russian ones. Messages of the commands and the findings follow the same language. The names of commands, flags, keys and variables are in English. The language key of the configuration tells the checks which language the documents of your project are written in; a check that judges wording and has no vocabulary for that language stays silent.

Calling a command ​

Every command is a subcommand of one entry point and runs from the root of the repository:

npx noomoo <command> [arguments]

An unknown subcommand prints the list of the available ones to standard error and exits with 1. Each call except event is recorded in the event log of the project (docs/ must exist): the command name, the exit code, the signal if any, the duration, the version of the package and the name of the npm script if the call came through one. Arguments are not recorded.

Exit codes ​

The meaning of a code is given in the entry of each command. The common convention is:

CodeMeaning
0The command did what it was asked to do, or only printed a plan.
1The command refused, or the verdict is red. The reason is printed to standard error or in the findings.
2Wrong arguments. A few commands (phase-check, reopen) use 1 for that.

Some gates use more codes to tell apart outcomes that need different actions; task-ready and plan-ready return 3 when a person must decide, 5 when the review timed out and 6 when the reviewing model could not be started.

Commands ​

PageCommands
Setup and diagnosticssetup, rollback, init, doctor, claude-hook-docs, contour-config, context-status, next, mcp, identity, locale-parity, public-artifact-check
Gates and verdictsvalidate, task-ready, plan-ready, phase-check, code-review, stamp, evidence, gate-accept, findings-accept, accepted-migrate, merge-green, commit-msg, bypass, stats
Tasks and documentsscaffold, raw, backlog-id, estimate, close-axis, reopen, event

Configuration and environment ​

  • Configuration — every key of config/pipeline.json with its default.
  • Environment — the environment variables that noomoo reads.

Trust and safety ​

The consent that several commands ask for is described in Trust model. What setup changes and rollback reverses is in What setup changes, and what noomoo writes and connects to is in Data and network.