Getting Started #

New to Raven? These guides take you from a fresh clone to your first tailored application drafts — no email sending required.

Raven is a local CLI: Discover jobs across ATS platforms and board feeds, Draft tailored emails or ATS form guides from your resume, and optionally Send outreach via Gmail or Outlook.

Pages in this section #

Installation

Installation #

Requirements #

Requirement	Version	Notes
Node.js	18+	Required
npm	bundled with Node	Required
Git	any	Clone the repository

Optional:

• Gmail or Microsoft OAuth credentials for raven send
• GEMINI_API_KEY for raven draft --gemini
• HF_TOKEN (HuggingFace) if openjobdata sync returns HTTP 401

Clone and setup #

From the Raven repository root:

git clone <your-raven-repo-url> raven
cd raven
./raven setup

raven setup runs:

1. npm install in the repo root
2. npm install in jobs/
3. Creates starter config from examples (if missing):

File	Purpose
.env	Sender identity, API keys, OAuth tokens
config/portals.yml	Job search filters
config/profile.yml	Identity, links, resume path
files/resume.md	Starter resume (replace with yours)

Install raven globally (optional) #

npm link
raven --help

Without npm link, use ./raven from the repo root.

Quick Start

Quick Start #

Five minutes from zero to your first tailored application drafts.

1. Setup #

cd raven
./raven setup

2. Configure filters and profile #

Edit config/portals.yml — what jobs to find:

title_filter:
  positive:
    - "software engineer"
    - "backend"
    - "developer"
  negative:
    - "nurse"
    - "sales"

location_filter:
  allow:
    - "Remote"
    - "India"

Edit config/profile.yml — who you are when drafting:

identity:
  name: "Your Name"
  email: "you@example.com"
  location: "City, Country"

links:
  resume: "files/resume.md"
  portfolio: "https://yoursite.dev"
  github: "https://github.com/you"
  linkedin: "https://linkedin.com/in/you"

Replace files/resume.md with your real resume (Markdown with ## Experience and - bullets works best).

Example Dry Run

Example Dry Run #

Complete pipeline walkthrough without sending email. Copy commands from your Raven repo root.

Step 0 — Install #

cd raven
./raven setup

Step 1 — Configure #

1. config/profile.yml — name, email, portfolio, GitHub, LinkedIn, resume path
2. files/resume.md — your resume with - bullets under ## Experience
3. config/portals.yml — title keywords (e.g. software engineer, backend, developer)

No Gmail OAuth needed for this dry run.

Recommended order #

Minimum setup before your first search #

./raven setup
# Edit config/profile.yml — name, email, links
# Replace files/resume.md with your resume
# Edit config/portals.yml — title filters for your target roles

Then run:

./raven discover --q "software engineer" --since 7
./raven draft --max 10
open drafts/outreach-*.md

Next: Installation →