pyr0ball
8cb636dabe
Adds a full MkDocs documentation site under docs/ with Material theme. Getting Started: installation walkthrough, 7-step first-run wizard guide, Docker Compose profile reference with GPU memory guidance and preflight.py description. User Guide: job discovery (search profiles, custom boards, enrichment), job review (sorting, match scores, batch actions), apply workspace (cover letter gen, PDF export, mark applied), interviews (kanban stages, company research auto-trigger, survey assistant), email sync (IMAP, Gmail App Password, classification labels, stage auto-updates), integrations (all 13 drivers with tier requirements), settings (every tab documented). Developer Guide: contributing (dev env setup, code style, branch naming, PR checklist), architecture (ASCII layer diagram, design decisions), adding scrapers (full scrape() interface, registration, search profile config, test patterns), adding integrations (IntegrationBase full interface, auto- discovery, tier gating, test patterns), testing (patterns, fixtures, what not to test). Reference: tier system (full FEATURES table, can_use/tier_label API, dev override, adding gates), LLM router (backend types, complete() signature, fallback chains, vision routing, __auto__ resolution, adding backends), config files (every file with field-level docs and gitignore status). Also adds CONTRIBUTING.md at repo root pointing to the docs site.
65 lines
2.4 KiB
Markdown
65 lines
2.4 KiB
Markdown
# Peregrine
|
|
|
|
**AI-powered job search pipeline — by [Circuit Forge LLC](https://circuitforge.io)**
|
|
|
|
Peregrine automates the full job search lifecycle: discovery, matching, cover letter generation, application tracking, and interview preparation. It is privacy-first and local-first — your data never leaves your machine unless you configure an external integration.
|
|
|
|
---
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
# 1. Clone and install dependencies
|
|
git clone https://git.circuitforge.io/circuitforge/peregrine
|
|
cd peregrine
|
|
bash setup.sh
|
|
|
|
# 2. Start Peregrine
|
|
make start # no GPU, API-only
|
|
make start PROFILE=single-gpu # one NVIDIA GPU
|
|
make start PROFILE=dual-gpu # dual GPU (Ollama + vLLM)
|
|
|
|
# 3. Open the UI
|
|
# http://localhost:8501
|
|
```
|
|
|
|
The first-run wizard guides you through hardware detection, tier selection, identity, resume, LLM configuration, search profiles, and integrations. See [Installation](getting-started/installation.md) for the full walkthrough.
|
|
|
|
---
|
|
|
|
## Feature Overview
|
|
|
|
| Feature | Free | Paid | Premium |
|
|
|---------|------|------|---------|
|
|
| Job discovery (JobSpy + custom boards) | Yes | Yes | Yes |
|
|
| Resume keyword matching | Yes | Yes | Yes |
|
|
| Cover letter generation | - | Yes | Yes |
|
|
| Company research briefs | - | Yes | Yes |
|
|
| Interview prep & practice Q&A | - | Yes | Yes |
|
|
| Email sync & auto-classification | - | Yes | Yes |
|
|
| Survey assistant (culture-fit Q&A) | - | Yes | Yes |
|
|
| Integration connectors (Notion, Airtable, etc.) | Partial | Yes | Yes |
|
|
| Calendar sync (Google, Apple) | - | Yes | Yes |
|
|
| Cover letter model fine-tuning | - | - | Yes |
|
|
| Multi-user support | - | - | Yes |
|
|
|
|
See [Tier System](reference/tier-system.md) for the full feature gate table.
|
|
|
|
---
|
|
|
|
## Documentation Sections
|
|
|
|
- **[Getting Started](getting-started/installation.md)** — Install, configure, and launch Peregrine
|
|
- **[User Guide](user-guide/job-discovery.md)** — How to use every feature in the UI
|
|
- **[Developer Guide](developer-guide/contributing.md)** — Add scrapers, integrations, and contribute code
|
|
- **[Reference](reference/tier-system.md)** — Tier system, LLM router, and config file schemas
|
|
|
|
---
|
|
|
|
## License
|
|
|
|
Core discovery pipeline: [MIT](https://git.circuitforge.io/circuitforge/peregrine/src/branch/main/LICENSE-MIT)
|
|
|
|
AI features (cover letter generation, company research, interview prep, UI): [BSL 1.1](https://git.circuitforge.io/circuitforge/peregrine/src/branch/main/LICENSE-BSL)
|
|
|
|
© 2026 Circuit Forge LLC
|