The package contains no review engine, provider SDK, database access, Git implementation, or credentials. Those remain inside the running Coducky app.

Quick start

Requirements: macOS, Node.js 20+, and the direct-download Coducky app installed and open as the same user.

npx coducky doctor
npx coducky reviewer list
npx coducky review run . --wait

Install it when repeated npx startup is undesirable:

npm install --global coducky
coducky review list .

Repositories must already be added to Coducky, and reviewers and credentials must be configured in the app.

Self-documenting API

The CLI is designed to be discoverable by both humans and coding agents:

coducky --help
coducky review run --help
coducky help --json
coducky help review results --json

Root and command help cover prerequisites, arguments, defaults, side effects, outputs, stable errors, exit codes, related commands, and examples. help --json exposes the same contract as versioned structured data and does not contact the app.

Use --json on operational commands to write exactly one versioned success or failure envelope to stdout. Human diagnostics go to stderr.

Commands

doctor
repo list
repo resolve <path>
reviewer list
review run <path>
review list [path]
review status <review-id>
review wait <review-id>
review results <review-id>
review cancel <review-id>
review open <review-id>

Run any command with --help for its complete contract.

Connection

The app owns an always-on, versioned local command server at:

~/Library/Application Support/com.coducky.app/command.sock

The socket is mode 0600; the app accepts only peers with the same effective user id. It is separate from Coducky's optional MCP server and does not depend on the MCP setting or repository scope.

Override the path for development with --socket <path> or CODUCKY_COMMAND_SOCKET.

Full project documentation: Coducky command-line interface.