Skip to content

SETUP.md

Latest commit

 

History

History
130 lines (94 loc) · 3.92 KB

SETUP.md

File metadata and controls

130 lines (94 loc) · 3.92 KB
Raw

Setup Guide

Prerequisites

  • An AI coding agent (GitHub Copilot CLI, Claude Code, Gemini CLI, Cursor, Windsurf, or any compatible tool)
  • Node.js 18+ (for PDF generation and utility scripts)

Quick Start (5 steps)

1. Choose an install path

  • Template repository: create a private copy before adding personal files.
  • Private fork: keep a link to upstream while keeping your own cv.md, profile, and tracker data private.
  • Local clone: try the workflow on your machine without publishing configuration.

The following commands use a local clone:

git clone https://github.com/RajjjAryan/career-copilot.git
cd career-copilot
npm install
npx playwright install chromium   # Required for PDF generation + browser tools

Personal files such as cv.md, config/profile.yml, modes/_profile.md, portals.yml, feeds.yml, and article-digest.md are gitignored by default.

1b. Playwright MCP (recommended)

The project includes a .vscode/mcp.json that configures the Playwright MCP server — this gives the AI agent native browser tools (browser_navigate, browser_snapshot, browser_click, etc.) for scraping SPA career pages like Ashby, Lever, and Workday.

If using VS Code / Copilot Agent Mode, this works automatically. For other MCP-compatible clients, add:

{
  "mcp": {
    "servers": {
      "playwright": {
        "command": "npx",
        "args": ["@playwright/mcp@latest"]
      }
    }
  }
}

For Claude Desktop, add to your claude_desktop_config.json:

{
  "mcpServers": {
    "playwright": {
      "command": "npx",
      "args": ["@playwright/mcp@latest"]
    }
  }
}

2. Check setup

npm run doctor                     # Validates all prerequisites

3. 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.

4. 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.

See examples/cv-example.md for a reference CV format.

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

5. 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

6. Start using

Open your AI coding tool in this directory. Then paste a job offer URL or description. The auto-pipeline will evaluate it, generate a report, create a tailored PDF, and track it.

AI Tool Configuration

Each supported tool reads its own instruction file automatically:

Tool File Setup
GitHub Copilot CLI .github/copilot-instructions.md Works automatically
Claude Code CLAUDE.md Works automatically
Cursor .cursorrules Works automatically
Windsurf .windsurfrules Works automatically
Gemini CLI GEMINI.md Works automatically
Other INSTRUCTIONS.md Read manually or configure your tool to read it

All files reference the canonical INSTRUCTIONS.md at the repository root.

Available Actions

Action How
Evaluate an offer Paste a URL or JD text
Search for offers Ask to "scan portals"
Process pending URLs Ask to "process pipeline"
Generate a PDF Ask to "generate PDF"
Batch evaluate Ask to "run batch"
Check tracker status Ask for "tracker status"
Fill application form Ask to "help apply"

Verify Setup

npm run doctor          # Check prerequisites
npm run sync-check      # Check configuration consistency
npm run verify          # Check pipeline integrity
npm test                # Run full test suite