Docs / CLI reference

CLI reference

Every notemend command.

Run with npx notemend … in the site's folder. The project is the nearest folder above with a package.json, or --root <dir>. Comments go to the linked cabinet project, or to feedback/comments.json when the site is not linked.

CommandWhat it does
notemend init [--yes] [--agents=…] [--force]Set the project up: config, the bar in the dev server, agents' hooks, .gitignore. --agents=claude,codex,gemini,cursor skips the question; --force rewrites an existing notemend.config.mjs
notemend init --ciA GitHub workflow where the agent works the queue on its own
notemend login [--code]Sign in to the cabinet in the browser, or with an emailed code
notemend link [<project-id>]File this site's comments into a cabinet project; no id makes a new one
notemend whoami | logout | unlinkWho you are and where comments go; undo either
notemendOpen comments for the agent
notemend allEvery comment, resolved ones and those for people included
notemend watch [--timeout <min>] [--start | --stop]Turbo: wait for a comment for the agent, print it and exit; meanwhile the bar shows the agent listening. --start un-pauses a turbo the bar paused, --stop takes the mark down
notemend watch --pushThe same in batches: wait for the bar's Push to Claude and take only what it sends
notemend start <id> [--force]Take a comment before fixing it: the thread shows the agent is on it; another agent is refused
notemend reply <id> "text"Answer in the thread without changing its state (note: the same, and the thread stays in hand; not with an agent key)
notemend done <id> ["note"] [--shot]Resolve as the agent, with a note; --shot files a picture after the fix
notemend reopen <id>Back to open
notemend rm <id>Delete the thread and its screenshots
notemend shot <id> ["note"] [--before]Picture of the element at the comment's width (needs Playwright and the dev server); a note goes in the thread as the agent's reply
notemend prune [--dry]Local store only: move resolved threads to feedback/archive/
notemend digest | countShort forms for agents' hooks (--format claude|codex|gemini|cursor)
notemend mcpThe queue as an MCP server over stdio
notemend --version | --helpThe version (and whether npm has a newer one); every command

Flags for any command

  • --as <agent> — sign replies as codex, gemini, cursor, copilot… (default: Claude).
  • --root <dir> — the project folder.
  • --url <dev server> — for screenshots; localhost:4321, or :3000 for Next.js.

Environment

  • NOTEMEND_URL — the dev server for screenshots, when there is no --url.
  • NOTEMEND_KEY — a project's agent key, in place of a sign-in (see An agent on its own).
  • NOTEMEND_PROJECT — the project for that key, when there is no .notemend.json.
  • NOTEMEND_HOME — where the sign-in and the version check are kept (default ~/.config/notemend).