Documentation

Oppy is an automated command-line utility to scrape, cache, filter, and track active paid remote internships and cash-prize hackathons. It caches listings in a local SQLite database and exports them directly to your Obsidian vault.

Installation

You can run Oppy instantly using Node.js without compiling or installing Python dependencies manually:

npx @dshenoyh/oppy-cli

Alternatively, install it globally on your system:

# Global Node install (Recommended)
npm install -g @dshenoyh/oppy-cli

# Pip Python environment install
pip install oppy-cli

CLI Commands

Query, synchronize, and examine opportunities directly from your standard shell terminal:

Command	Action
`oppy`	Launches the interactive terminal TUI dashboard panel.
`oppy -s "query"`	Search cached opportunities in console output without loading the TUI.
`oppy -a`	Audits your local resume file against opportunity listings to rank compatibility.
`oppy -e` or `--edit`	Opens your skills resume file automatically in the system's default text editor.
`oppy -H` or `--headless`	Trigger background crawler synchronization. Ideal for crontabs or systemd timers.
`oppy --export md\|pdf\|csv`	Writes the cached ledger to disk in the chosen format. Pass `--out PATH` to control the destination; defaults to `./Opportunities.<format>`.

Configuration

Oppy persists configuration schema locally in your home directory at:
~/.config/oppy/config.json

{
  "remote_only": true,
  "paid_only": true,
  "selected_platforms": ["unstop", "devpost", "remoteok", "weworkremotely"],
  "export_path": "/home/user/Obsidian/Vault/Opportunities.md",
  "resume_path": "/home/user/.config/oppy/resume.txt",
  "custom_rss_feeds": [
    "https://weworkremotely.com/categories/remote-full-stack-programming-jobs.rss"
  ]
}

Resume Auditor

Oppy features a local-first resume auditor. When running oppy --audit for the first time, it initializes a template file at:
~/.config/oppy/resume.txt

Open this file in any text editor and fill in your technical stack details (languages, libraries, frameworks). You can open it instantly from your terminal by running: oppy --edit or oppy -e. Oppy extracts your skills, cross-references them against active database opportunities, and renders a fit rating alongside missing prerequisites.