Skip to content

Quickstart ​

This page takes a repository from nothing to a setup noomoo watches, and shows how to undo it. It needs Node.js 20 or newer and git.

Install ​

npm install -D noomoo

See the plan before anything changes ​

npx noomoo setup

The command prints the files it would create, the scripts and git settings it would touch, and what it would do with a core.hooksPath you already have. It writes nothing.

Apply the setup ​

npx noomoo setup --yes

Everything the plan listed is written and recorded in .noomoo/setup-manifest.json.

Check the installation ​

npx noomoo doctor
npx noomoo validate
npx noomoo context-status

doctor reports what is installed and what is missing, validate checks the documents of the project, and context-status shows the merge state of your branch.

Undo it ​

npx noomoo rollback
npx noomoo rollback --yes

The first command prints what would be removed and restored. The second applies it and keeps every file you changed after setup.

Every command, flag and configuration key is described in Reference.