Installation

Requirements

• Python 3.11 or newer.
• A host coding CLI — Claude Code, Codex, Gemini CLI, or OpenCode. The host agent runs the reasoning steps.

That's it. The default discovery source is a free, open dataset: no API key, no signup. A host CLI is the only thing pip doesn't install for you.

Install

$ git clone https://github.com/vbkatarnaware/careeros
$ cd careeros
$ pip install -e ".[ats-dataset]"

The ats-dataset extra (pandas, pyarrow, httpx) lets CareerOS read the free discovery dataset: 65 real ATS platforms, no key required. Skip it and CareerOS still installs fine — it just tells you discovery is unavailable until you add it back.

Optional extras

Each extra is opt-in. A fresh clone runs the daily pipeline without any of them.

# Google Drive backup + PDF rendering
$ pip install -e ".[drive,pdf]"
 
# Background form-reading for Application Answers (JS-only forms)
$ pip install -e ".[apply]"
$ playwright install chromium
 
# Optional paid discovery source (Fantastic Jobs), disabled by default
# no extra pip install — just an API key, see Configuration
 
# The test suite
$ pip install -e ".[dev]"

Confirm your setup

careeros doctor is a read-only first-run checklist. It checks your Python version, profile, discovery credentials, Sheets, Drive, and Playwright — and tells you exactly what's missing. It never modifies anything.

$ careeros doctor

Scaffold your workspace

careeros init creates the local .careeros/ directory with a config file and an example profile. Everything CareerOS writes lives under this folder, and it's gitignored.

$ careeros init