You don’t need to memorize any commands. The steps below show what happens under the hood, but in practice you install once and let your agent drive.
1. Install the binary
macOS (Intel or Apple Silicon) or Linux (x64 or arm64). One command:resume to ~/.local/bin/resume. Verify:
Windows
Windows
There’s no native Windows build yet. Install WSL2 (a Linux environment for Windows) and run the same command from your WSL shell — it installs the Linux build.
PATH and Gatekeeper
PATH and Gatekeeper
If the installer says
~/.local/bin isn’t on your PATH, add the line it prints to your ~/.zshrc or ~/.bashrc, then open a new terminal. On macOS the installer also clears the Gatekeeper quarantine flag, so the binary just runs.Linux: glibc only
Linux: glibc only
The binaries target glibc. Lightweight musl-based distros (Alpine, some minimal Docker images) aren’t supported — use Debian, Ubuntu, Fedora, or Arch.
2. Point your agent at it
- Claude Code (recommended)
- Any other agent
Install the bundled skill so the agent knows how to drive the tool, then start a new session:This copies the skill into
~/.claude/skills/resume-as-code/. Open Claude Code in your resume folder and it already knows how to manage your resume.3. Start your resume — two ways
Your resume lives in a folder you own (a git repository). Pick whichever fits:Make a folder, open your agent in it
Just ask your agent
Start your agent anywhere and say:
“Use resume-as-code to start my resume.”It asks where the resume should live and initializes it.
4. Let your agent lead the setup
The first time, your agent leads — it doesn’t wait to be asked. Behind the scenes it runs a read-only readiness check and walks you through:Check readiness
The agent runs
resume bootstrap to see whether you’re inside a resume repo, whether git is initialized, whether this is a first run, and which optional tools are present.Initialize the repo (if needed)
If you aren’t in a resume repo yet, the agent runs
resume init — scaffolding resume/, a git repo, and a CLAUDE.md / AGENTS.md bootstrap so any agent that opens the folder knows what it is and how to help.Import an existing resume — if you have one
The agent asks: “Do you have a current resume — a PDF, Word doc, LinkedIn export, or JSON Resume file? Point me at it and I’ll import it.”LinkedIn exports and JSON Resume files import deterministically; PDFs and Word docs are read and structured into entries for you to review.
Or seed from scratch
No resume yet? The agent fills in the essentials by conversation — your name, headline, contact, summary, and your most recent role.
Dependencies
Everything core works with the binary alone. A few capabilities use optional tools, whichresume bootstrap reports on:
| Capability | Needs | If missing |
|---|---|---|
| PDF import | nothing | Installing pdftotext (Poppler) improves layout fidelity; otherwise the bundled unpdf fallback handles it. |
| PDF export | Chrome for Testing | Downloaded automatically (~170 MB) on the first export, or pre-fetch with resume bootstrap --ensure-chrome. |
| DOCX export | pandoc | Install pandoc; the readiness report prints the command for your OS. |
The CLI never installs system tools for you and never prompts — it surfaces what’s missing, and your agent helps you install it.
What’s next
Command reference
Browse every
resume command by category.In-binary cheatsheet
Run
resume cheatsheet any time for the exhaustive, always-current reference your agent reads.