pyr0ball
3458122537
Some checks failed
CI / test (push) Failing after 21s
- Rename setup.sh to install.sh (standardise with cf-orch installer pattern) - Remove hardcoded dev-machine path from activate_git_hooks(); go straight to .githooks/ core.hooksPath fallback — the absolute path was only valid on the author's machine and surprised self-hosters - Add capture_license_key(): optional CFG-XXXX-… prompt after setup_env(), writes CF_LICENSE_KEY + HEIMDALL_URL into .env when a valid key is entered - Fix next-steps port: read STREAMLIT_PORT from .env instead of hardcoding 8501 (Docker default is 8502; users who customise the port saw a wrong URL) - Update .env.example: STREAMLIT_PORT=8502 (Docker default, not bare-metal 8501) - Fix stale git clone URL in docs/getting-started/installation.md: git.circuitforge.io → git.opensourcesolarpunk.com/Circuit-Forge/peregrine - Update all setup.sh references across manage.sh, Makefile, CONTRIBUTING.md, README.md, and docs/ to install.sh Closes #71
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 install.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
|