docs/SETUP.md

Setup Guide

Prerequisites

• Claude Code installed and configured
• Node.js 18+ (for PDF generation and utility scripts)
• (Optional) Go 1.21+ (for the dashboard TUI)

Quick Start (5 steps)

1. Clone and install

git clone https://github.com/santifer/career-ops.gitcd career-opsnpm installnpx playwright install chromium   # Required for PDF generation

2. Configure your profile

cp config/profile.example.yml config/profile.yml

Edit config/profile.yml with your personal details: name, email, target roles, narrative, proof points.

3. Add your CV

Create cv.md in the project root with your full CV in markdown format. This is the source of truth for all evaluations and PDFs.

(Optional) Create article-digest.md with proof points from your portfolio projects/articles.

4. Configure portals

cp templates/portals.example.yml portals.yml

Edit portals.yml:

• Update title_filter.positive with keywords matching your target roles
• Add companies you want to track in tracked_companies
• Customize search_queries for your preferred job boards

5. Start using

Open Claude Code in this directory:

claude

Then paste a job offer URL or description. Career-ops will automatically evaluate it, generate a report, create a tailored PDF, and track it.

Available Commands

Verify Setup

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

Build Dashboard (Optional)

cd dashboardgo build -o career-dashboard ../career-dashboard --path ..  # Opens TUI pipeline viewer