CodeRook CLI

CodeRook from the terminal, on Windows, macOS and Linux alike. It uses the same engines as the desktop application — the same scanner, the same .gitignore rules, the same upload, download and .cbx bundling — so a project moved by one is understood by the other.

Install

Requires Node 20.11 or later, and nothing else.

npm install --global @coderook/cli

Or from this repository:

cd cli
npm install
npm run build
npm link

Sign in

Create a personal access token in Settings on coderook.com, then:

coderook sign-in

The token is written to a file only your account can read:

| Platform | Location | | --- | --- | | Windows | %APPDATA%\CodeRook | | macOS | ~/Library/Application Support/CodeRook | | Linux | $XDG_CONFIG_HOME/coderook, or ~/.config/coderook |

For automation, set CODEROOK_TOKEN instead and nothing is written to disk. CODEROOK_API_URL points the tool at a different service.

Everyday use

coderook status                    what is here that is not saved yet
coderook submit -m "Fixed the parser"
coderook get                       fetch the latest version over this folder
coderook clone my-project          fetch a project into a new folder

status and submit act on the current directory unless you name another. The first time either runs in a folder, it looks for a project on your account whose name matches and links the two, so a folder you already uploaded from the desktop is recognised rather than treated as new.

submit sends only what changed. Files the service already holds are not uploaded again, and the version it records still names every file in the project — a version is a snapshot, not a difference.

Ignore rules

coderook rules            show the rules in force
coderook rules --init     write a starter .gitignore

Rules live in the project's own .gitignore, so CodeRook, git, the website and the desktop application all read one file. A ! line puts something back. Personal exclusions that should not reach a collaborator belong in .git/info/exclude.

Bundles

coderook bundle                    pack this project as <name>.cbx
coderook unbundle backup.cbx       extract one
coderook inspect backup.cbx        see what it holds  (--files to list them)

A .cbx is the CodeBox bundle format: content-defined chunks, Zstandard where it helps, raw where it does not, and a SHA-256 for every chunk and file. Extraction is verified and atomic — a damaged bundle fails rather than leaving a half-written tree.

Checking things

coderook doctor

Reports the tool's version, where its configuration lives, whether the service is reachable, and who this machine is signed in as.

Exit codes

0 on success, 1 on failure. Every command prints why it failed on standard error, so a script can branch on the status and log the reason.