Files
santifer--career-ops/docs/SETUP.md
T
wehub-resource-sync d083df1fdb
CodeQL Analysis / Analyze (javascript-typescript) (push) Failing after 2s
Web CI / web typecheck + build (push) Failing after 1s
Release Please / release-please (push) Failing after 1s
CodeQL Analysis / Analyze (go) (push) Failing after 16s
chore: import upstream snapshot with attribution
2026-07-13 12:02:43 +08:00

3.8 KiB

Setup Guide

Prerequisites

  • An AI coding CLI — Claude Code, Gemini CLI, Codex, Qwen Code, OpenCode, GitHub Copilot CLI, Antigravity CLI, or Grok Build CLI (see Supported CLIs)
  • Node.js 18+ and git (npx ships with Node — the installer refuses to run without them) — note: the Gemini CLI integration requires Node.js 20+
  • (Optional) Go 1.21+ (for the dashboard TUI)

Quick Start

npx @santifer/career-ops init

npx ships with Node.js — it runs the installer once without installing anything globally. This clones the latest release into ./career-ops and installs dependencies. Then move into the workspace and open your AI CLI:

cd career-ops
claude   # or codex / qwen / opencode / agy / grok

On first launch, career-ops walks you through setup by chatting — it asks for your CV, your details (name, target roles, salary), and sets up the job scanner with pre-configured companies. Nothing to edit by hand: just answer its questions. Then paste a job offer URL or description and it evaluates it, writes a report, generates a tailored PDF, and tracks it.

If you are using Codex, start the interactive session with codex. Slash commands are not guaranteed in Codex, so use the same mode names in a prompt if /career-ops is unavailable:

Evaluate this JD with career-ops auto-pipeline: https://company.com/jobs/123
Run the career-ops scan mode.
Run the career-ops pipeline mode.
Run the career-ops pdf mode.
Run the career-ops email mode for the latest evaluated role. Draft only; never sends, submits, or clicks.
Run the career-ops tracker mode.

For one-shot workers or batch tasks in Codex, use codex exec. See docs/CODEX.md for the full guide.

codex exec "Evaluate this JD with career-ops auto-pipeline: https://company.com/jobs/123"
codex exec "Run career-ops scan mode in this repo."
codex exec "Run career-ops pipeline mode for data/pipeline.md."
codex exec "Run career-ops pdf mode for the latest evaluated role."
codex exec "Run career-ops email mode for the latest evaluated role. Draft only; do not send, submit, or click anything."
codex exec "Run career-ops tracker mode and summarize the current statuses."

Advanced — clone manually

Prefer to clone the repo yourself?
git clone https://github.com/santifer/career-ops.git
cd career-ops
npm install

Then open your AI CLI in the folder — the same first-run onboarding applies. Use this path if you want to track a specific branch, contribute, or audit the code before installing dependencies.

PDF rendering (one-time)

PDFs are rendered with a headless Chromium. Install it once per machine:

npx playwright install chromium

Available Commands

Action How
Evaluate an offer Paste a URL or JD text
Search for offers /career-ops scan or ask the agent to run scan
Process pending URLs /career-ops pipeline or ask the agent to run pipeline
Generate a PDF /career-ops pdf or ask the agent to run pdf
Draft application email /career-ops email or ask the agent to run email; draft-only, never sends, submits, or clicks
Batch evaluate /career-ops batch or use codex exec "Run career-ops batch mode ..."
Check tracker status /career-ops tracker or ask the agent to run tracker
Fill application form /career-ops apply or ask the agent to run apply

Verify Setup

node cv-sync-check.mjs      # Check configuration
node verify-pipeline.mjs     # Check pipeline integrity

Build Dashboard (Optional)

npm run serve:dashboard     # Opens TUI pipeline viewer
npm run build:dashboard     # Optional: build the standalone binary