mirror of
https://github.com/MadsLorentzen/ai-job-search.git
synced 2026-11-02 13:12:50 +00:00
docs(readme): redesign README with animated SVG diagrams (#778)
Replace the ASCII workflow diagram with animated SVGs built from Pip's palette: a hero where Pip flies an application to its destination, the 69/20/1 application funnel as envelopes, the six-command route, and the /apply draft-review loop. Long reference material moves into collapsible sections; all content and the anchors SETUP.md links to are kept.
This commit is contained in:
1 parent
4b109c20c3
commit
eb0fcd71fb
5 files changed
+445
-114
No files matched your search
@@ -1,20 +1,39 @@
|
||||
<p align="center">
|
||||
<img src="assets/mascot/pip_flight_loop.gif" alt="Pip, the courier bird" width="200">
|
||||
<img src="assets/readme/hero.svg" alt="AI Job Search. Pip the courier bird carries an application along a flight path to its destination. The job search that runs on your machine." width="100%">
|
||||
</p>
|
||||
|
||||
# AI Job Search
|
||||
|
||||
*The job search that runs on your machine.*
|
||||
<p align="center">
|
||||
<a href="https://github.com/ai-job-search-dev/ai-job-search/actions/workflows/ci.yml"><img src="https://github.com/ai-job-search-dev/ai-job-search/actions/workflows/ci.yml/badge.svg" alt="CI" height="20"></a>
|
||||
|
||||
<a href="https://claude.com/claude-code"><img src="https://img.shields.io/badge/built_on-Claude_Code-2A9D8F?style=flat" alt="Built on Claude Code" height="20"></a>
|
||||
|
||||
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-2A9D8F?style=flat" alt="MIT license" height="20"></a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://trendshift.io/repositories/43622?utm_source=trendshift-badge&utm_medium=badge&utm_campaign=badge-trendshift-43622" target="_blank" rel="noopener noreferrer"><img src="https://trendshift.io/api/badge/trendshift/repositories/43622/daily" alt="MadsLorentzen%2Fai-job-search | Trendshift" width="250" height="55"/></a>
|
||||
</p>
|
||||
|
||||
[](https://github.com/ai-job-search-dev/ai-job-search/actions/workflows/ci.yml)
|
||||
<p align="center">
|
||||
An AI-powered job application framework built on <a href="https://claude.com/claude-code">Claude Code</a>.<br>
|
||||
Fork it, fill in your profile, and let Claude evaluate job postings, tailor your CV,<br>
|
||||
write cover letters, and prepare you for interviews.
|
||||
</p>
|
||||
|
||||
An AI-powered job application framework built on [Claude Code](https://claude.com/claude-code). Fork it, fill in your profile, and let Claude evaluate job postings, tailor your CV, write cover letters, and prepare you for interviews.
|
||||
<p align="center">
|
||||
<a href="#quick-start"><b>Quick start</b></a>
|
||||
|
||||
<a href="#commands"><b>Commands</b></a>
|
||||
|
||||
<a href="#how-apply-works"><b>How /apply works</b></a>
|
||||
|
||||
<a href="#customization"><b>Customization</b></a>
|
||||
|
||||
<a href="SETUP.md"><b>Setup guide</b></a>
|
||||
</p>
|
||||
|
||||
> Note: This is an independent open-source project and is not affiliated with, endorsed by, sponsored by, or maintained by Anthropic. Anthropic and Claude Code are referenced only to describe the toolchain this workflow uses.
|
||||
> [!NOTE]
|
||||
> This is an independent open-source project and is not affiliated with, endorsed by, sponsored by, or maintained by Anthropic. Anthropic and Claude Code are referenced only to describe the toolchain this workflow uses.
|
||||
>
|
||||
> This project has **no affiliated cryptocurrency, token, or paid sponsorship program**. Anything claiming otherwise is unauthorized and should be treated as a scam. The only ways to support the project are the Ko-fi link below and contributing on GitHub.
|
||||
|
||||
@@ -22,6 +41,10 @@ An AI-powered job application framework built on [Claude Code](https://claude.co
|
||||
|
||||
I'm a geophysicist by training. When my position was cut in late 2025, I built this framework to run my own job search - the same `/scrape`, `/apply`, and `/interview` workflow in this repo, used weekly, on my own career. I was upfront about it with every employer I spoke to, and instead of counting against me, it usually sparked a genuine technical conversation.
|
||||
|
||||
<p align="center">
|
||||
<img src="assets/readme/letters.svg" alt="69 envelopes for 69 tailored applications. 20 of them light up as first interviews, and one is sealed as the signed contract." width="100%">
|
||||
</p>
|
||||
|
||||
Sixty-nine tailored applications, twenty first interviews, and one signed contract later, I started as an AI engineer in June 2026. People kept asking whether this actually works. It got me hired. Now it's yours.
|
||||
|
||||
*The longer version, including the full application funnel, is on [LinkedIn](https://www.linkedin.com/in/mads-lorentzen/).*
|
||||
@@ -39,38 +62,39 @@ Sixty-nine tailored applications, twenty first interviews, and one signed contra
|
||||
|
||||
## What this is
|
||||
|
||||
A structured workflow that turns Claude Code into a full-stack job application assistant. The core workflow (self-profiling, fit evaluation, and the drafter-reviewer application pipeline) is **language- and country-agnostic**. The job portal search skills are built for the Danish market (Jobindex, Jobnet, Akademikernes Jobbank, etc.), but the pattern is designed to be swapped for your local job boards.
|
||||
A structured workflow that turns Claude Code into a full-stack job application assistant. Six commands carry you from an empty profile to a tracked result:
|
||||
|
||||
```
|
||||
/setup /scrape /apply <url>
|
||||
| | |
|
||||
v v v
|
||||
Fill in Search job Evaluate fit
|
||||
your profile portals Score & recommend
|
||||
| | |
|
||||
v v v
|
||||
Profile Present matches Draft CV + Cover Letter
|
||||
files ready with fit ratings (LaTeX, tailored)
|
||||
| |
|
||||
v v
|
||||
Pick a match Reviewer agent critiques
|
||||
-> /apply -> Revise -> Final output
|
||||
```
|
||||
<p align="center">
|
||||
<img src="assets/readme/route.svg" alt="The workflow in order: /setup builds your profile, /scrape finds new postings, /rank shortlists the fits, /apply tailors a CV and cover letter, /interview preps every round, /outcome tracks each result." width="100%">
|
||||
</p>
|
||||
|
||||
The core workflow (self-profiling, fit evaluation, and the drafter-reviewer application pipeline) is **language- and country-agnostic**. The job portal search skills are built for the Danish market (Jobindex, Jobnet, Akademikernes Jobbank, etc.), but the pattern is designed to be swapped for your local job boards.
|
||||
|
||||
The framework encodes career guidance best practices, including structured evaluation criteria, forward-looking cover letter framing, and optional salary benchmarking.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- [Claude Code](https://claude.com/claude-code) (CLI). Claude Code has no free tier: you need a Claude Pro/Max/Team subscription or Anthropic API credits (pay-per-token, usually cheaper for occasional use). Using a different agent tool (Codex, Antigravity, Gemini CLI)? Start at [`AGENTS.md`](AGENTS.md) - the portal search skills work there out of the box, and [community forks](https://github.com/ai-job-search-dev/ai-job-search/discussions/78) adapt the full workflow.
|
||||
- Python 3.10+
|
||||
- [Bun](https://bun.sh) (for job search CLI tools)
|
||||
- LaTeX distribution with `lualatex` and `xelatex`: [TeX Live](https://tug.org/texlive/), [MacTeX](https://tug.org/mactex/), [TinyTeX](https://yihui.org/tinytex/), or [MiKTeX](https://miktex.org/). The CV compiles with `lualatex` (pdflatex often fails on modern MiKTeX installs with `fontawesome5` font-expansion errors); the cover letter compiles with `xelatex` because `cover.cls` requires `fontspec`. If using a minimal TeX install such as TinyTeX or BasicTeX, install the extra packages listed in [SETUP.md](SETUP.md#minimal-tex-install-tinytexbasictex).
|
||||
- Optional: `pip install pypdf` for `/apply`'s ATS parseability check (BSD; no Poppler required). Poppler `pdftotext` remains a fallback (macOS: `brew install poppler`, Debian/Ubuntu: `apt install poppler-utils`, Windows: `choco install poppler`). If both are missing, the check degrades to a visual keyword review.
|
||||
|
||||
## Quick start
|
||||
|
||||
> 🎥 **Prefer to see it in action first?** [The Next New Thing did a hands-on walkthrough](https://www.youtube.com/watch?v=HoVxjMNFYv4) of how the workflow is actually used, from setup to a finished application (recorded August 2026 - commands may have evolved since).
|
||||
|
||||
### What you need
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| **[Claude Code](https://claude.com/claude-code)** | The CLI. No free tier: a Claude Pro/Max/Team subscription or Anthropic API credits (pay-per-token, usually cheaper for occasional use). |
|
||||
| **Python 3.10+** | For the tools in `tools/`. |
|
||||
| **[Bun](https://bun.sh)** | Runs the job search CLI tools. |
|
||||
| **LaTeX** | A distribution with `lualatex` and `xelatex`: [TeX Live](https://tug.org/texlive/), [MacTeX](https://tug.org/mactex/), [TinyTeX](https://yihui.org/tinytex/), or [MiKTeX](https://miktex.org/). |
|
||||
| **pypdf** *(optional)* | `pip install pypdf` for `/apply`'s ATS parseability check. |
|
||||
|
||||
<details>
|
||||
<summary>Fine print: other agents, LaTeX engines, PDF text extraction</summary>
|
||||
|
||||
- **Using a different agent tool** (Codex, Antigravity, Gemini CLI)? Start at [`AGENTS.md`](AGENTS.md) - the portal search skills work there out of the box, and [community forks](https://github.com/ai-job-search-dev/ai-job-search/discussions/78) adapt the full workflow.
|
||||
- **LaTeX engines.** The CV compiles with `lualatex` (pdflatex often fails on modern MiKTeX installs with `fontawesome5` font-expansion errors); the cover letter compiles with `xelatex` because `cover.cls` requires `fontspec`. If using a minimal TeX install such as TinyTeX or BasicTeX, install the extra packages listed in [SETUP.md](SETUP.md#minimal-tex-install-tinytexbasictex).
|
||||
- **PDF text extraction.** `pypdf` is BSD-licensed and needs no Poppler. Poppler `pdftotext` remains a fallback (macOS: `brew install poppler`, Debian/Ubuntu: `apt install poppler-utils`, Windows: `choco install poppler`). If both are missing, the check degrades to a visual keyword review.
|
||||
|
||||
</details>
|
||||
|
||||
### 1. Fork and clone
|
||||
|
||||
```bash
|
||||
@@ -93,10 +117,15 @@ cd ai-job-search
|
||||
python3 tools/install_portal_clis.py # Windows: python tools\install_portal_clis.py
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>What the installer does</summary>
|
||||
|
||||
It runs `bun install` in every portal CLI under `.agents/skills/*/cli/` - discovered, not listed, so a portal you add with `/add-portal` or copy from another fork is included on a fresh clone. A CLI whose `package.json` declares an install-time lifecycle script is skipped and reported rather than run. `--dry-run` shows what it would install.
|
||||
|
||||
For `linkedin-search` and `freehire-search` the install is optional: both have zero runtime dependencies and run with plain `bun`; `bun install` only pulls TypeScript dev types.
|
||||
|
||||
</details>
|
||||
|
||||
### 3. Set up your profile
|
||||
|
||||
```bash
|
||||
@@ -129,11 +158,32 @@ If the URL can't be fetched (some job portals block automated access), you can p
|
||||
|
||||
This runs the full workflow: evaluate fit, draft CV + cover letter, review with a second agent, revise, and present the final output. The posting passes a deterministic integrity gate first (hidden text, invisible characters, instruction-shaped lines, hidden links), and its one-line verdict opens the evaluation; the agents that fetch and review read-only.
|
||||
|
||||
Postings are treated as untrusted input (the workflow follows no instructions embedded in them and fetches no links from their body), but agentic defenses are instruction-level, not a sandbox - on an unfamiliar job board, skim what was fetched and written before you hit send. Details in [SECURITY.md](SECURITY.md).
|
||||
> [!WARNING]
|
||||
> Postings are treated as untrusted input (the workflow follows no instructions embedded in them and fetches no links from their body), but agentic defenses are instruction-level, not a sandbox - on an unfamiliar job board, skim what was fetched and written before you hit send. Details in [SECURITY.md](SECURITY.md).
|
||||
|
||||
## Other commands
|
||||
## Commands
|
||||
|
||||
`/setup`, `/scrape`, and `/apply` form the core workflow. Ten more commands extend it once your profile is in place:
|
||||
`/setup`, `/scrape`, and `/apply` form the core workflow. Ten more commands extend it once your profile is in place.
|
||||
|
||||
| Command | What it does |
|
||||
|---|---|
|
||||
| **`/setup`** | Builds your profile from your documents, a pasted CV, or an interview |
|
||||
| **`/scrape`** | Searches job portals for postings that match your profile |
|
||||
| **`/apply`** | Evaluates fit, then drafts, reviews, and compiles a tailored CV and cover letter |
|
||||
| `/rank` | Batch-scores a scrape into a ranked shortlist |
|
||||
| `/interview` | Builds a stage-specific prep pack and runs a mock interview |
|
||||
| `/outcome` | Records results, archives what you sent, and drafts follow-ups |
|
||||
| `/gmail-sync` | Proposes application status updates from your Gmail |
|
||||
| `/notion-sync` | Publishes a read-only view of your pipeline to Notion |
|
||||
| `/html-report` | Generates an offline dashboard of your applications |
|
||||
| `/expand` | Adds competencies found in your public profiles and course syllabi |
|
||||
| `/upskill` | Maps your skill gaps and builds a learning plan |
|
||||
| `/add-template` | Registers your own CV or cover letter template |
|
||||
| `/add-portal` | Generates a search skill for a job board in your market |
|
||||
| `/reset` | Wipes profile data or documents - see [Starting over](#starting-over) |
|
||||
|
||||
<details>
|
||||
<summary><b>Full command reference</b></summary>
|
||||
|
||||
- **`/interview`** preps you for a scheduled interview on a tracked application. It builds a stage-specific prep pack from the application's archive (the exact posting, the CV and cover letter the interviewer actually read, feedback recorded from earlier rounds), researches the company and interviewers with a verify-before-use rule, maps likely questions to your STAR examples, and offers a mock interview following the roleplay protocol in `07-interview-prep.md`. Gaps get honest bridge answers, never invented experience.
|
||||
- **`/outcome`** records what happened to an application - interview stages, offers, rejections, silence. It archives the submitted CV, cover letter, and posting text into `documents/applications/<company>_<role>/`, keeps `outcome.md` in the format `/setup` Path A parses, and updates the tracker. It also owns the stretch before there is an outcome to record: `/outcome followup` surfaces open applications that have gone quiet (default 10 days), drafts a short channel-appropriate follow-up in your writing style using only claims from the materials you already submitted (drafts only, never sends; at most twice per application), and offers a thank-you note in the same turn an interview stage is recorded. Once a few applications resolve, it points you back to `/setup` to calibrate the fit framework from what actually got interviews.
|
||||
@@ -146,87 +196,14 @@ Postings are treated as untrusted input (the workflow follows no instructions em
|
||||
- **`/add-template`** registers your own CV or cover letter template (LaTeX, Typst, or another toolchain) in place of the stock ones. It captures the template's instructions (source extension, compile command, fonts, style rules, page limit), runs a mandatory test compile, and wires the template into `/apply`. See [Custom templates](#custom-templates) below.
|
||||
- **`/add-portal`** generates a job-portal search skill for a job board in your market. It investigates the portal (search URL pattern, result structure, access rules), scaffolds the CLI skill from the same structure as the shipped ones, and test-runs a live query before registering. See [Job search tools](#job-search-tools) below.
|
||||
|
||||
`/reset` is also available, see [Starting over](#starting-over) below.
|
||||
|
||||
## File structure
|
||||
|
||||
```
|
||||
ai-job-search/
|
||||
├── CLAUDE.md # Main candidate profile + workflow rules
|
||||
├── .claude/
|
||||
│ ├── commands/
|
||||
│ │ ├── apply.md # /apply workflow (drafter-reviewer)
|
||||
│ │ ├── setup.md # /setup onboarding (documents folder, CV import, or interview)
|
||||
│ │ ├── expand.md # /expand competency enrichment from documents and online presence
|
||||
│ │ ├── add-template.md # /add-template register custom templates (LaTeX, Typst, ...)
|
||||
│ │ ├── add-portal.md # /add-portal generate a job-portal search skill for your market
|
||||
│ │ ├── rank.md # /rank triage scraped jobs into a ranked shortlist
|
||||
│ │ ├── outcome.md # /outcome record application results, archive materials
|
||||
│ │ ├── gmail-sync.md # /gmail-sync auto-detect application status from Gmail
|
||||
│ │ ├── interview.md # /interview stage-specific prep pack + mock interview
|
||||
│ │ ├── html-report.md # /html-report generate application tracker dashboard
|
||||
│ │ ├── notion-sync.md # /notion-sync one-way pipeline view in a Notion database
|
||||
│ │ └── reset.md # /reset wipe profile data or documents folder
|
||||
│ ├── skills/
|
||||
│ │ ├── job-application-assistant/ # Core application skill
|
||||
│ │ │ ├── SKILL.md # Skill definition
|
||||
│ │ │ ├── 01-candidate-profile.md # Your education, experience, skills
|
||||
│ │ │ ├── 02-behavioral-profile.md# PI/DISC/personality assessment
|
||||
│ │ │ ├── 03-writing-style.md # Tone, structure, do's and don'ts
|
||||
│ │ │ ├── 04-job-evaluation.md # Scoring framework for job fit
|
||||
│ │ │ ├── 05-cv-templates.md # LaTeX CV structure + tailoring rules
|
||||
│ │ │ ├── 06-cover-letter-templates.md # LaTeX cover letter templates
|
||||
│ │ │ └── 07-interview-prep.md # STAR examples + interview framework
|
||||
│ │ ├── job-scraper/ # Job search orchestration
|
||||
│ │ └── upskill/ # /upskill skill gap analysis and learning plan
|
||||
│ └── settings.json # Claude Code permissions (shared, scoped)
|
||||
├── .agents/skills/ # Job portal CLI tools
|
||||
│ ├── jobbank-search/ # Akademikernes Jobbank (Denmark)
|
||||
│ ├── jobdanmark-search/ # Jobdanmark.dk (Denmark)
|
||||
│ ├── jobindex-search/ # Jobindex.dk (Denmark)
|
||||
│ ├── jobnet-search/ # Jobnet.dk (Denmark, government portal)
|
||||
│ ├── linkedin-search/ # LinkedIn public job listings (country-agnostic)
|
||||
│ └── freehire-search/ # freehire.me tech job aggregator (multi-market, REST API)
|
||||
├── cv/
|
||||
│ └── main_example.tex # moderncv LaTeX template
|
||||
├── cover_letters/
|
||||
│ ├── cover.cls # Custom cover letter LaTeX class
|
||||
│ ├── cover_example.tex # Example cover letter (structural reference + CI smoke test)
|
||||
│ └── OpenFonts/ # Lato + Raleway fonts
|
||||
├── templates/ # Custom templates registered via /add-template
|
||||
│ └── README.md # Folder layout instructions
|
||||
├── documents/ # Career source materials for /setup Path A and /expand
|
||||
│ ├── README.md # Folder layout instructions
|
||||
│ ├── cv/ # Master CV (PDF or .tex)
|
||||
│ ├── linkedin/ # LinkedIn profile export (PDF)
|
||||
│ ├── diplomas/ # Degree certificates and transcripts
|
||||
│ ├── references/ # Reference letters
|
||||
│ └── applications/ # Past application records (<company>_<role>/)
|
||||
├── .github/workflows/ci.yml # CI: LaTeX smoke compiles, skill lint, CLI typechecks
|
||||
├── salary_lookup.py # Salary benchmarking tool (BYO data)
|
||||
├── tools/
|
||||
│ ├── check_framework_version.py # CI check: framework_version bumped when skill files change
|
||||
│ ├── check_upstream_updates.py # Preview which personalized files an upstream update touches
|
||||
│ ├── convert_salary_excel.py # Convert salary Excel to JSON
|
||||
│ ├── fetch_page.py # GET-only browser-header retry for 403s (robots.txt enforced)
|
||||
│ ├── install_portal_clis.py # Install every discovered portal CLI (bun install)
|
||||
│ ├── lint_skills.py # CI lint for skills, commands, settings.json
|
||||
│ ├── posting_guard.py # Integrity gate: strip hidden text, flag injection-shaped lines
|
||||
│ ├── robots_check.py # Gate the browser-header retry against robots.txt
|
||||
│ ├── security_guards.py # CI guards: permission allow/ask/deny, skill grants, gitignore, manifests
|
||||
│ ├── upstream_triage.py # Sort upstream commits into worth-reviewing vs probably-skip
|
||||
│ ├── verify_layout.py # Measure a compiled PDF's page layout (holes, orphans, footer collisions)
|
||||
│ ├── verify_pdf.py # Verify a compiled PDF's page count and extractable text
|
||||
│ └── README_SALARY_TOOL.md # Salary tool setup instructions
|
||||
├── job_scraper/ # Scraper state (seen jobs, results)
|
||||
├── gmail_sync/ # /gmail-sync state (processed message IDs, last sync date)
|
||||
├── upskill/ # /upskill report output (markdown reports per run)
|
||||
├── job_search_tracker.csv # Application tracking spreadsheet
|
||||
└── SETUP.md # Detailed setup guide
|
||||
```
|
||||
</details>
|
||||
|
||||
## How `/apply` works
|
||||
|
||||
<p align="center">
|
||||
<img src="assets/readme/apply.svg" alt="A job posting passes an integrity gate and fit evaluation, then loops through draft, review, revise, and compile plus inspect until the CV is exactly two pages, the cover letter one page, and the ATS text layer is checked." width="100%">
|
||||
</p>
|
||||
|
||||
The `/apply` command runs a **drafter-reviewer workflow** with mandatory PDF compilation:
|
||||
|
||||
1. **Parse** the job posting (URL or text)
|
||||
@@ -240,7 +217,8 @@ The `/apply` command runs a **drafter-reviewer workflow** with mandatory PDF com
|
||||
|
||||
All claims in the CV and cover letter are verified against your actual profile. The system never fabricates skills or experience.
|
||||
|
||||
### What makes this workflow different
|
||||
<details>
|
||||
<summary><b>What makes this workflow different</b></summary>
|
||||
|
||||
- **PDF verification loop.** Most LaTeX-resume templates produce "looks fine in the .tex" output that breaks in the PDF: job titles orphan to the next page, cover letters spill onto page 2, bullet fonts silently fall back to the body font. The `/apply` command compiles and visually inspects every PDF and applies targeted fixes (`\needspace`, `\enlargethispage`, font-matching wrappers for list items) until the layout is clean. This runs automatically on every application.
|
||||
- **ATS verification on the PDF text layer.** An ATS reads the PDF's embedded text, not the rendered page — and LaTeX can silently produce PDFs whose text extracts as garbage (icon glyphs where the email should be, interleaved lines from multi-column layouts). `/apply` extracts the compiled CV's text layer with `pdftotext` and verifies contact details, reading order, and the posting's keyword coverage against what a parser actually sees. Honesty rule enforced: a keyword the profile doesn't support is acknowledged as a gap, never stuffed in.
|
||||
@@ -248,6 +226,8 @@ All claims in the CV and cover letter are verified against your actual profile.
|
||||
- **Drafter-reviewer separation.** The drafter writes; a second Claude agent, spawned with a fresh context, researches the company and critiques the drafts. The drafter then revises. This catches missed keywords, weak framing, and generic language that a single pass often leaves in.
|
||||
- **Token-efficient reviewer dispatch.** The reviewer agent receives drafts inline rather than re-reading them, and the verification checklist runs once at the end of the workflow rather than being duplicated by both agents. Note: the new compile-and-inspect step in Step 5 spends some of those savings on PDF rendering and layout iteration — the workflow trades some end-to-end token cost for a real reduction in broken PDFs reaching the user.
|
||||
|
||||
</details>
|
||||
|
||||
## Customization
|
||||
|
||||
### Which files to edit manually
|
||||
@@ -315,7 +295,14 @@ Everything above adds up to an extension model, so here it is stated plainly. Th
|
||||
|
||||
1. **Portal skills** - the module system for job boards. Every `*-search` skill is a self-contained folder under `.agents/skills/` with the same contract (a `search`/`detail` CLI, `--format json|table|plain` output, an `enabled:` flag in its `SKILL.md`, its own tests). `/scrape` auto-discovers any installed skill that follows the contract - nothing to register, nothing to wire up. `/add-portal` generates new ones; the [community portal index](https://github.com/ai-job-search-dev/ai-job-search/discussions/78) catalogs the ones other forks have built.
|
||||
2. **Document templates** - `/add-template` registers any CV or cover-letter toolchain that compiles to PDF from the command line, LaTeX or otherwise.
|
||||
3. **Evaluation criteria** - deal-breakers and preferences in your profile are free-form, and the evaluation rubric scores against whatever you put there. "Strong parental-leave terms", "minimum salary X per my union's scale", "no on-call" - each is one profile line, no code, and it carries real weight in `/rank` and `/apply` fit evaluations. Language is the one deal-breaker type with dedicated, structured handling: `/setup` captures every language you work in and your level (asked directly, or inferred from your CV/LinkedIn export) into a `Languages` table, and the Language Gate (`04-job-evaluation.md`) hard-rejects a posting that requires a language you haven't declared at all, while flagging - not auto-rejecting - one that asks for a higher level than you declared in a language you do work in, so a borderline case (a strict "fluent" bar against your own B1/B2, say) gets your judgment instead of a silent drop.
|
||||
3. **Evaluation criteria** - deal-breakers and preferences in your profile are free-form, and the evaluation rubric scores against whatever you put there. "Strong parental-leave terms", "minimum salary X per my union's scale", "no on-call" - each is one profile line, no code, and it carries real weight in `/rank` and `/apply` fit evaluations.
|
||||
|
||||
<details>
|
||||
<summary>How the Language Gate handles language deal-breakers</summary>
|
||||
|
||||
Language is the one deal-breaker type with dedicated, structured handling: `/setup` captures every language you work in and your level (asked directly, or inferred from your CV/LinkedIn export) into a `Languages` table, and the Language Gate (`04-job-evaluation.md`) hard-rejects a posting that requires a language you haven't declared at all, while flagging - not auto-rejecting - one that asks for a higher level than you declared in a language you do work in, so a borderline case (a strict "fluent" bar against your own B1/B2, say) gets your judgment instead of a silent drop.
|
||||
|
||||
</details>
|
||||
|
||||
**Borrowing a portal skill from another fork** is the intended way to get a board that upstream doesn't ship: find it in the [portal index](https://github.com/ai-job-search-dev/ai-job-search/discussions/78), open that fork, and copy the one folder into your own `.agents/skills/`. Before you run it:
|
||||
|
||||
@@ -366,6 +353,89 @@ The framework supports two distinct modes of job searching:
|
||||
|
||||
To get the most from this, invest time during `/setup` in describing not just your experience, but what energized you, what drained you, and what you'd want more of. This context directly shapes how the system evaluates fit and which roles it surfaces during `/scrape`.
|
||||
|
||||
## File structure
|
||||
|
||||
<details>
|
||||
<summary>Show the repository layout</summary>
|
||||
|
||||
```
|
||||
ai-job-search/
|
||||
├── CLAUDE.md # Main candidate profile + workflow rules
|
||||
├── .claude/
|
||||
│ ├── commands/
|
||||
│ │ ├── apply.md # /apply workflow (drafter-reviewer)
|
||||
│ │ ├── setup.md # /setup onboarding (documents folder, CV import, or interview)
|
||||
│ │ ├── expand.md # /expand competency enrichment from documents and online presence
|
||||
│ │ ├── add-template.md # /add-template register custom templates (LaTeX, Typst, ...)
|
||||
│ │ ├── add-portal.md # /add-portal generate a job-portal search skill for your market
|
||||
│ │ ├── rank.md # /rank triage scraped jobs into a ranked shortlist
|
||||
│ │ ├── outcome.md # /outcome record application results, archive materials
|
||||
│ │ ├── gmail-sync.md # /gmail-sync auto-detect application status from Gmail
|
||||
│ │ ├── interview.md # /interview stage-specific prep pack + mock interview
|
||||
│ │ ├── html-report.md # /html-report generate application tracker dashboard
|
||||
│ │ ├── notion-sync.md # /notion-sync one-way pipeline view in a Notion database
|
||||
│ │ └── reset.md # /reset wipe profile data or documents folder
|
||||
│ ├── skills/
|
||||
│ │ ├── job-application-assistant/ # Core application skill
|
||||
│ │ │ ├── SKILL.md # Skill definition
|
||||
│ │ │ ├── 01-candidate-profile.md # Your education, experience, skills
|
||||
│ │ │ ├── 02-behavioral-profile.md# PI/DISC/personality assessment
|
||||
│ │ │ ├── 03-writing-style.md # Tone, structure, do's and don'ts
|
||||
│ │ │ ├── 04-job-evaluation.md # Scoring framework for job fit
|
||||
│ │ │ ├── 05-cv-templates.md # LaTeX CV structure + tailoring rules
|
||||
│ │ │ ├── 06-cover-letter-templates.md # LaTeX cover letter templates
|
||||
│ │ │ └── 07-interview-prep.md # STAR examples + interview framework
|
||||
│ │ ├── job-scraper/ # Job search orchestration
|
||||
│ │ └── upskill/ # /upskill skill gap analysis and learning plan
|
||||
│ └── settings.json # Claude Code permissions (shared, scoped)
|
||||
├── .agents/skills/ # Job portal CLI tools
|
||||
│ ├── jobbank-search/ # Akademikernes Jobbank (Denmark)
|
||||
│ ├── jobdanmark-search/ # Jobdanmark.dk (Denmark)
|
||||
│ ├── jobindex-search/ # Jobindex.dk (Denmark)
|
||||
│ ├── jobnet-search/ # Jobnet.dk (Denmark, government portal)
|
||||
│ ├── linkedin-search/ # LinkedIn public job listings (country-agnostic)
|
||||
│ └── freehire-search/ # freehire.me tech job aggregator (multi-market, REST API)
|
||||
├── assets/ # README artwork (Pip the mascot, animated SVG diagrams)
|
||||
├── cv/
|
||||
│ └── main_example.tex # moderncv LaTeX template
|
||||
├── cover_letters/
|
||||
│ ├── cover.cls # Custom cover letter LaTeX class
|
||||
│ ├── cover_example.tex # Example cover letter (structural reference + CI smoke test)
|
||||
│ └── OpenFonts/ # Lato + Raleway fonts
|
||||
├── templates/ # Custom templates registered via /add-template
|
||||
│ └── README.md # Folder layout instructions
|
||||
├── documents/ # Career source materials for /setup Path A and /expand
|
||||
│ ├── README.md # Folder layout instructions
|
||||
│ ├── cv/ # Master CV (PDF or .tex)
|
||||
│ ├── linkedin/ # LinkedIn profile export (PDF)
|
||||
│ ├── diplomas/ # Degree certificates and transcripts
|
||||
│ ├── references/ # Reference letters
|
||||
│ └── applications/ # Past application records (<company>_<role>/)
|
||||
├── .github/workflows/ci.yml # CI: LaTeX smoke compiles, skill lint, CLI typechecks
|
||||
├── salary_lookup.py # Salary benchmarking tool (BYO data)
|
||||
├── tools/
|
||||
│ ├── check_framework_version.py # CI check: framework_version bumped when skill files change
|
||||
│ ├── check_upstream_updates.py # Preview which personalized files an upstream update touches
|
||||
│ ├── convert_salary_excel.py # Convert salary Excel to JSON
|
||||
│ ├── fetch_page.py # GET-only browser-header retry for 403s (robots.txt enforced)
|
||||
│ ├── install_portal_clis.py # Install every discovered portal CLI (bun install)
|
||||
│ ├── lint_skills.py # CI lint for skills, commands, settings.json
|
||||
│ ├── posting_guard.py # Integrity gate: strip hidden text, flag injection-shaped lines
|
||||
│ ├── robots_check.py # Gate the browser-header retry against robots.txt
|
||||
│ ├── security_guards.py # CI guards: permission allow/ask/deny, skill grants, gitignore, manifests
|
||||
│ ├── upstream_triage.py # Sort upstream commits into worth-reviewing vs probably-skip
|
||||
│ ├── verify_layout.py # Measure a compiled PDF's page layout (holes, orphans, footer collisions)
|
||||
│ ├── verify_pdf.py # Verify a compiled PDF's page count and extractable text
|
||||
│ └── README_SALARY_TOOL.md # Salary tool setup instructions
|
||||
├── job_scraper/ # Scraper state (seen jobs, results)
|
||||
├── gmail_sync/ # /gmail-sync state (processed message IDs, last sync date)
|
||||
├── upskill/ # /upskill report output (markdown reports per run)
|
||||
├── job_search_tracker.csv # Application tracking spreadsheet
|
||||
└── SETUP.md # Detailed setup guide
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
## Contributing
|
||||
|
||||
Thinking about a PR? Read [CONTRIBUTING.md](CONTRIBUTING.md) first - it explains what gets merged, what lives in forks, and why.
|
||||
@@ -378,3 +448,8 @@ Thinking about a PR? Read [CONTRIBUTING.md](CONTRIBUTING.md) first - it explains
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
||||
<p align="center">
|
||||
<img src="assets/mascot/pip_flight_loop.gif" alt="Pip, the courier bird" width="120"><br>
|
||||
<sub>Pip delivers. Good luck out there.</sub>
|
||||
</p>
|
||||
Reference in new issue
Block a user