CLI Commands

careerrat CLI

The primary entry point. Run as careerrat <command> [args] [--flags].

Command	What it does
`start [agent]`	Scaffold workspace, install skills, boot dashboard, launch agent
`start claude`	Same, with Claude Code as the agent
`start codex`	Same, with Codex as the agent
`init`	Scaffold workspace only (no agent, no dashboard)
`doctor`	Environment health check, scaffold state, skills discoverability
`next`	Show the next agent task from doctor guidance
`ingest`	Guided candidate setup (profile, targeting, evidence, etc.)
`searches`	Build and curate the search-source config
`companies`	Manage tracked employer ATS boards
`evaluate`	Run the body-read gate on a saved job
`tracker`	One-shot dashboard snapshot, summary, follow-ups, or `--verify`
`tracker-dev`	Live-updating local app server on `:7777`
`modes`	Show or change optional usage and application modes
`automation`	Show or toggle opt-in browser-automation config
`activity`	Read, append, or prune Activity Pulse events
`research`	Read or record web-research artifacts
`stories`	Read, validate, or add STAR+R interview stories
`strategy-review`	Stamp a strategy-review run
`analytics`	Compute tracker analytics
`evidence`	Read, validate, or add evidence claims
`questions`	Fetch a job's real application-form questions, no browser
`data`	sqlite-backed data layer: status, init, import, export, verify, plus per-domain verbs
`health`	Record the company-health skill's role-scoped rating
`gate`	Safely update gate data such as comp floors and exclusions
`learnings`	Read or append per-role-family learnings
`status-map`	Inspect ATS status normalization
`export`	Render a tailored artifact or packet to PDF or DOCX
`update`	Pull latest code from npm; data untouched
`restore`	Recover `tracker.json` from a rolling snapshot (confirm-first)
`install-skills`	Re-shim `.claude/skills` to `.agents/skills`
`--version`	Print installed version

start flags

Flag	Effect
`--no-agent`	Scaffold + local app only
`--no-dashboard`	Agent only, no local app server
`--agent <name>`	Override with a compatible agent command
`--port <n>`	Local app port (default 7777)

npm scripts (source checkout)

Most users should use careerrat <command>. These npm scripts are useful when developing from a source checkout or running lower-level maintenance tools.

Development

Script	What it does
`lint`	Run Biome checks
`lint:fix`	Run Biome with safe fixes
`format`	Format files with Biome
`test`	Run the Node test suite
`site:dev`	Run the marketing website locally
`site:build`	Build the marketing website and embedded docs
`docs:dev`	Run the docs app locally
`docs:build`	Build the standalone docs export

Validation

Script	What it does
`verify:tracker`	Validate `.careerrat/workspace/tracker.json` schema and integrity
`lint:placeholders`	Check tailored artifacts for unresolved placeholders

Capture and analysis

Script	What it does
`capture:search-sources`	Bulk-capture board listing pages
`capture:board`	Capture a single board page
`analyze:outcomes`	Read outcome analytics from tracker
`check:jobs`	Check liveness of sourced job links
`scan:sourced`	Scan configured sourced rows
`delta:sourced`	Show sourced-row deltas
`calibrate:style`	Build writing-style calibration artifacts

Environment variables

Variable	Default	Purpose
`CAREERRAT_HOME`	`<repo root>/.careerrat`	Override location of `.careerrat/` (holding `candidate/` and `workspace/`)
`NEXT_PUBLIC_SITE_URL`	(unset)	Docs-site base URL for metadata