Setting up Sweepy
You've installed Sweepy! Now you need a profile.
A configuration profile specifies to Sweepy the jobs to find and the resume to score them against. It also sets your target location.
A profile is a small text file in YAML format. YAML, which rhymes with camel, organizes data with indentation, colons, and line breaks. You don't need to write code: if you can read a grocery list, you can read YAML.
Option A: Run the interactive setup wizardโ
The setup wizard creates a working profile from plain answers. It opens the search launchpad before the questionnaire and writes the configuration file for you.
Run this command:
sweepy --setup
The wizard prints its banner, then the launchpad. The status line under the tiles shows the loaded profile, such as Current profile: Alex Rivera / 4 titles / Ready. With nothing loaded yet, it reads Current profile: none loaded / build one to start.
The launchpad shows six tiles. Launch Sweep runs the loaded profile. Load Profile opens a saved search. Build Profile starts a new search and asks plain-English questions. Sweep Settings controls ranking, cards, and history. Sweepy's Toolbox holds profile editing, engine management, aggregator management, the debug toggle, help, recent logs, document conversion, and updates. Exit Sweepy saves your changes and closes the wizard.
The command reference lists the flags behind each entry.
Here's the terminal output from Alex's first wizard session, which takes the Build Profile path:
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
โ SWEEPY / SEARCH LAUNCHPAD โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ โ
โ โ 01 LAUNCH SWEEP โ โ 04 BUILD PROFILE โ โ
โ โ Run your job search now โ โ Set up your job search โ โ
โ โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ โ
โ โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ โ
โ โ 02 LOAD PROFILE โ โ 05 SWEEP SETTINGS โ โ
โ โ Open a search you saved โ โ Ranking, cards, tracking โ โ
โ โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ โ
โ โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ โ
โ โ 03 SWEEPY'S TOOLBOX โ โ 06 EXIT SWEEPY โ โ
โ โ Edit profile, logs, help โ โ Save changes and close โ โ
โ โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ Current profile: none loaded / build one to start โ
โ โ โ โ โ navigate Enter select Esc exit โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
Selected: 04 BUILD PROFILE
What is your name? Alex Rivera
What job titles are you looking for?
(Separate multiple titles with a comma)
> Paralegal, Legal Assistant, Litigation Support Specialist, Legal Secretary
Where do you want to work? (City, State): New York, NY
Do you want to see remote-only roles? (yes/no): no
Do you want to include hybrid roles? (yes/no): yes
What is the path to your resume PDF?
Hint: In File Explorer, select the file and press Ctrl+Shift+C (Windows 11); on older Windows, Shift+right-click and pick Copy as path.
> Alex_Rivera_Resume.pdf
What is your minimum target salary? (Leave blank to skip): 65000
Which platforms do you want to search?
[x] Greenhouse
[x] Ashby
[x] Lever
[x] Workable
[ ] Aggregator feeds (Remotive, Adzuna)
Do you want to add custom platforms or ATS domains? (yes/no): yes
Enter custom platform names and domains (format: Name:domain.com, comma-separated):
e.g. SmartRecruiters:smartrecruiters.com, Breezy HR:breezy.hr
> SmartRecruiters:smartrecruiters.com, Breezy HR:breezy.hr
Enter must-have skills or keywords to prioritize (comma-separated, leave blank to extract from resume): Westlaw, LexisNexis, e-discovery, Contract Review, Legal Research
What export formats do you want?
[x] PDF Report
[x] CSV Spreadsheet
[ ] JSON Data
Add job-tracking columns to the CSV? (date applied, status, interview stage, offer, follow-up date, contact, notes): (yes/no): yes
Do you want to configure multiple resume tracks (e.g. Tech Writer vs UX Writer)? (yes/no): no
Enable debug logging? (Logs are saved under logs/ in the application directory): (yes/no): no
What would you like to do?
1. Submit profile
2. Edit an answer
3. Toggle job tracking columns
4. Manage job engines
5. Adjust engine performance
6. Download job engines
7. Convert a document to PDF (bonus)
8. Show help
9. Show recent logs
10. Start over
Re-run sweepy --setup at any time to create a new profile or edit an existing one. The wizard writes to the file it names and leaves your other profiles alone.
To skip the launchpad and edit a saved profile straight away, pass the --profile flag:
sweepy --setup --profile profiles/paralegal_nyc.yaml
Option B: Edit the config file manuallyโ
To type your settings directly, copy the sample template and open it in a plain-text editor such as Notepad or VS Code. Avoid word processors, which replace straight quotes with curly quotes and break YAML.
- Windows
- macOS / Linux
copy config.sample.yaml profiles\alex_rivera_paralegal.yaml
notepad profiles\alex_rivera_paralegal.yaml
cp config.sample.yaml profiles/alex_rivera_paralegal.yaml
open profiles/alex_rivera_paralegal.yaml # macOS
# or: nano profiles/alex_rivera_paralegal.yaml # Linux
Alex's profileโ
The wizard writes this file to profiles/alex_rivera_paralegal.yaml. Lines that start with # are comments: they explain each setting, and Sweepy ignores them. Sweepy fills in a default for any section or setting you leave out.
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
# Sweepy โ Alex's Paralegal Profile
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
# Your name (appears in the PDF report header)
name: "Alex Rivera"
# โโโ Job Search Settings โโโโโโโโโโโโโโโโโโโโโโโโโโ
search:
# List every job title you want to find.
# The engine searches for ALL of these titles simultaneously.
titles:
- "Paralegal"
- "Legal Assistant"
- "Litigation Support Specialist"
- "Legal Secretary"
# Your target city and state.
location: "New York, NY"
# Set to true to ONLY see remote roles.
# Set to false to see remote, hybrid, and on-site roles.
remote_only: false
# Set to false to exclude hybrid positions.
include_hybrid: true
# Minimum annual salary filter (optional).
# Leave as 0 or remove this line to skip salary filtering.
min_salary: 65000
# โโโ Resume Settings โโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
resume:
# The full path to your resume PDF on your computer.
# On Windows, use double backslashes (\\) or forward slashes (/).
path: "Alex_Rivera_Resume.pdf"
# Must-have skills to prioritize for the match percentage.
must_have_skills:
- "Westlaw"
- "LexisNexis"
- "e-discovery"
- "Contract Review"
- "Legal Research"
# How heavily to weigh keyword matches when scoring roles.
# 1.0 = standard weight. Increase to 2.0 if you want
# exact skill matches to dominate the score.
keywords_weight: 1.5
# โโโ Platform Settings โโโโโโโโโโโโโโโโโโโโโโโโโโโโ
# Set each platform to true or false to enable or disable it.
platforms:
greenhouse: true
ashby: true
lever: true
workable: true
aggregators: false # Free feeds like Remotive, Adzuna
# Optional: custom ATS endpoints or company career domains
custom:
- name: "SmartRecruiters"
domain: "smartrecruiters.com"
enabled: true
- name: "Breezy HR"
domain: "breezy.hr"
enabled: true
# โโโ Export Settings โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
export:
# Comma-separated list of output formats.
# Options: pdf, csv, json
format: "pdf,csv"
# Where to save the output files.
# The engine creates this folder if it does not exist.
output_dir: "results"
On Windows: use double backslashes (\\) or forward slashes (/) in YAML paths. One backslash (\) breaks YAML formatting.
โ
Correct: "C:\\Users\\Alex\\Documents\\resume.pdf" or "C:/Users/Alex/Documents/resume.pdf"
โ Incorrect: "C:\Users\Alex\Documents\resume.pdf"
Using preset profilesโ
Sweepy includes ready-to-use profile presets in the profiles/ folder. These four cover common searches:
| File | Career path | Titles searched |
|---|---|---|
paralegal_nyc.yaml | Legal | Paralegal, Legal Assistant, Litigation Support Specialist, Legal Secretary |
frontend_developer.yaml | Software engineering | Front End Developer, React Developer, UI Engineer |
tech_writer.yaml | Technical writing | Technical Writer, UX Writer, Content Designer |
template_custom.yaml | Any career | Sample titles you swap out. Each setting has a comment. |
To use a preset, pass its filename when you run a sweep:
sweepy --profile profiles/frontend_developer.yaml
You can create as many profiles as you want. Store a different one for each job title variation or city you target. Switch between them instantly using the --profile flag.
Option C: Automate with a chat assistantโ
A chat assistant can build profiles and run sweeps for you. Sweepy includes a built-in Model Context Protocol (MCP) server, so the assistant reads and writes your profiles directly. The MCP integration guide covers client setup for Antigravity, Claude Desktop, and VS Code, and the MCP tool reference lists all of Sweepy's tools.
Look up every settingโ
The configuration reference lists every setting a profile accepts, from debug and resume.tracks to sources.* and report.*. Keep it open while you edit your profile.
Check where Sweepy looks for jobsโ
Sweepy queries four public applicant tracking systems by default. That group covers Greenhouse, Ashby, Lever, and Workable. It also queries Built In NYC, a New York job board. Aggregator feeds from LinkedIn, Indeed, Glassdoor, and ZipRecruiter run through python-jobspy when your profile enables them.
Optional engines add boards. The options are HireHunt, OpenRoles, JobDrop, and Apify. OpenRoles requires a company list before it runs. Apify requires an APIFY_TOKEN. JobDrop conflicts with JobSpy's dependency pin. The setup wizard's Download job engines option installs them.
The sources and platforms page covers optional engines, seed files, custom platform entries, and compatibility caveats.
Your profile is ready. It's time to run your first sweep.