Getting Started
Installation
Prerequisites
- git and GitHub CLI (
gh) - authenticated - AI CLI (one of):
- Claude CLI
- Gemini CLI
- LaTeX (for PDF generation):
- BasicTeX (recommended for Mac)
- MacTeX
- TeX Live
- uv - required for agent mode
Setup
Run the initialization wizard in your repository:
The wizard will:
- Link your GitHub repo - auto-detected from git remote
- Select CLI agent - Claude or Gemini
- Set CV source path - your CV data file
- Set letter source path - your letter data file
- Set reference directory - additional context for AI
- Create/link GitHub Project - with job-tracking statuses
Your First Application
1. Add a Job Posting
This will:
- Fetch and parse the job posting
- Extract structured details using AI
- Create a GitHub issue
- Add to your project board
2. Analyze Match Quality
Get AI-powered analysis of how well your CV matches the position.
3. Build Tailored Documents
Interactive Mode (default):
Uses Claude or Gemini CLI for real-time editing with tool use.
Agent Mode:
Structured TOML output with Pydantic validation.
4. Approve and Submit
Commits, tags, pushes, and updates project status to "Applied".
5. View Later
Opens the PDF from the git tag.
Workflow Summary
cvx init # Initialize project
cvx add <url> # Add job posting
cvx advise <issue> # Analyze job-CV match
cvx build [issue] # Build tailored CV/cover letter
cvx approve [issue] # Commit, tag, push
cvx view <issue> # View submitted documents
Build Modes
Interactive CLI Mode (Default)
Best for iterative refinement:
Benefits:
- Direct file editing by AI
- Session persistence
- Interactive conversation
- Auto-detects claude or gemini CLI
Agent Mode
Best for structured, repeatable output:
Benefits:
- Schema-validated output
- Multi-provider support
- Automatic fallback on failure
- TOML output
Requirements:
- uv installed
- Data files:
src/cv.toml,src/letter.toml - Schema:
schema/schema.json
Other Commands
cvx list # View all applications
cvx list --company google # Filter by company
cvx rm <issue> # Remove application
Next Steps
- Commands - Full command reference
- Configuration - Customize settings
- Architecture - How it works
- Schema Reference - YAML/TOML structure