CareerRat
Reference

CLI Commands

Every public CareerRat CLI command plus maintainer-only npm scripts.

careerrat CLI

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

CommandWhat it does
start [agent]Scaffold workspace, install skills, open the terminal workspace, launch agent
start claudeSame, with Claude Code as the agent
start codexSame, with Codex as the agent
people list / people add <name> / people remove <name> --purge --yesList, create (with an authorization note) or purge per-person workspaces. These work on the shared roster. --for <name> applies to workspace commands; --new creates the person first. See Running CareerRat for someone else
--for <name> people contact show|set|opt-in|opt-outRecord the address CareerRat may notify, their timezone and quiet hours, and their per-channel yes. Notifications fail without an opt-in
--for <name> roundup [--since <date>] [--send] [--now]Print a person's job-search roundup, or email it to their registered address. See Running CareerRat for someone else
--for <name> comm handoff <id> --deliver-to-personEmail a reviewed recruiter-reply draft to the person, never the recruiter. comm mark-sent <id> records their send
initScaffold workspace only (no agent, no terminal workspace)
doctorEnvironment health check, scaffold state, skills discoverability
nextShow the next agent task from doctor guidance
ingestGuided candidate setup (profile, targeting, evidence, etc.)
searchesBuild and curate the search-source config
companiesManage tracked employer ATS boards
evaluateRun the body-read gate on a saved job
trackerOne-shot tracker snapshot, summary, follow-ups, or --verify
tracker-devLegacy: live-updating browser workspace on :7777
modesShow or change optional usage and application modes
automationShow or switch browser-automation capabilities on and off
activityRead, append, or prune Activity Pulse events
researchRead or record web-research artifacts
storiesRead, validate, or add STAR+R interview stories
strategy-reviewStamp a strategy-review run
analyticsCompute tracker analytics
evidenceRead, validate, or add evidence claims
questionsFetch a job's real application-form questions, no browser
datasqlite-backed data layer: status, init, import, export, verify, plus per-domain verbs
healthRecord the company-health skill's role-scoped rating
applySubmit gate for agent-filled forms: checks the live form and presses Submit only when every check passes
gateSafely update gate data such as comp floors and exclusions
learningsRead or append per-role-family learnings
status-mapInspect ATS status normalization
exportRender a tailored artifact or packet to PDF or DOCX
updatePull latest code from npm; data untouched
restoreRecover tracker.json from a rolling snapshot (confirm-first)
install-skillsRe-shim .claude/skills to .agents/skills
--versionPrint installed version

start flags

FlagEffect
--no-agentOpen the terminal workspace without starting a chat
--agent <name>Use claude or codex
--browserLegacy: serve the browser workspace instead
--no-dashboardLegacy: terminal agent session without the workspace
--port <n>Legacy browser workspace port (default 7777, needs --browser)

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

ScriptWhat it does
lintRun Biome checks
lint:fixRun Biome with safe fixes
formatFormat files with Biome
testRun the Node test suite
site:devRun the marketing website locally
site:buildBuild the marketing website and embedded docs
docs:devRun the docs app locally
docs:buildBuild the standalone docs export

Validation

ScriptWhat it does
verify:trackerValidate .careerrat/workspace/tracker.json schema and integrity
lint:placeholdersCheck tailored artifacts for unresolved placeholders

Capture and analysis

ScriptWhat it does
capture:search-sourcesBulk-capture board listing pages
capture:boardCapture a single board page
analyze:outcomesRead outcome analytics from tracker
check:jobsCheck whether saved job links are still open, using the job board's own API first, and list jobs closed since the last check
scan:sourcedScan configured sources. Boards that return not found on two runs in a row are skipped until a 14-day re-check; --recheck-dead checks them now
delta:sourcedShow sourced-row deltas
calibrate:styleBuild writing-style calibration artifacts

Environment variables

VariableDefaultPurpose
CAREERRAT_HOME<repo root>/.careerratOverride location of .careerrat/ (holding candidate/ and workspace/)
CAREERRAT_PERSON(unset)Run in the workspace at <data root>/people/<name>/, same as --for <name>
CAREERRAT_DOWNLOADS_DIR~/Documents/careerrat (~/Documents/careerrat/_people/<name> with a person)Where exported documents go
NEXT_PUBLIC_SITE_URL(unset)Docs-site base URL for metadata

On this page