Documentation

Install

The installer detects your OS and architecture and downloads the matching prebuilt binary from GitHub Releases into ~/.local/bin. No Rust toolchain required.

Supported platforms

• macOS — x86_64 (Intel) and arm64 (Apple Silicon)
• Linux — x86_64 and arm64 (glibc)
• Windows — use WSL

Environment overrides

Build from source

Prefer to compile it yourself? Clone the repo and build with Cargo:

$ git clone https://github.com/itsTowhid/resumable-cli
$ cd resumable-cli
$ cargo build --release   # binary at target/release/resumable

Quick start (Zero Learning Curve)

To run the entire workflow end-to-end, you only need to run a single command:

$ mkdir job-hunt && cd job-hunt
$ resumable

The interactive wizard will automatically guide you through configuring your settings, importing your resume data, tailoring it for a job posting, rendering it to PDF/HTML, and opening the resulting folder. Simply run resumable again at any point to pick up where you left off.

Prerequisites

• One AI CLI installed and logged in, auto-detected in this order:
  • agy — Antigravity CLI (default / highest priority)
  • claude — Claude Code
  • codex — OpenAI Codex CLI
• For PDF output: a Chromium-based browser (Google Chrome, Chromium, or Microsoft Edge). A puppeteer-downloaded Chrome (~/.cache/puppeteer) is also detected.

Commands

Every subcommand at a glance. Bare resumable runs the interactive workflow or resumes where you left off.

init

Set up a workspace: writes .config/resumable.config.json (the user data file is created during the import step).

resumable init [--dir <path>] [--force]

$ mkdir job-hunt && cd job-hunt
$ resumable init

tailor

Tailor your resume to a job description. Provide the JD in one of three ways (in priority order):

1. --url <url> — fetch a job posting URL and extract readable text from the HTML
2. --jd <file> — read the JD from a local file
3. Interactive menu — when neither flag is given, choose from: enter a URL, read from job_description.txt (if it exists), or paste the JD text

It saves the JD to job_description.txt in the company folder and writes the tailored resume.md — nothing else. It does not render a PDF, because AI output should be reviewed first, then prints the exact render command to run.

resumable tailor [--url <url> | --jd <file>] [--resume <file>] [--ai claude|codex|agy] [--force]

$ resumable tailor --url https://jobs.example.com/senior-engineer
$ resumable tailor --jd role.txt --ai claude
$ resumable tailor                        # interactive menu
$ resumable                               # bare command == tailor

render (no AI)

Render an already-tailored resume, or preview your data, without touching the AI. Accepts a company folder (renders its resume.md), a .md file, or a resume .json (formatted to Markdown deterministically). Output is written next to the input as <name>_<template>.<ext>.

resumable render <input> [--template <name>] [--html] [--pdf] [--photo <file>] [--force]

With no --template, it renders every template enabled in the config (so you can compare designs); --template <name> forces a single one. PDF is the default when neither --html nor --pdf is given.

$ resumable render Bright-Labs                          # one PDF per enabled template
$ resumable render Bright-Labs/resume.md --template elegant --html
$ resumable render .config/user_data.json --pdf                 # straight from resume data

import

Already have a résumé? import reads a PDF / Word doc / text file and produces .config/user_data.json. The AI only structures the text it finds; it does not invent data, and leaves unknown fields empty.

resumable import --from <file> [--out <file>] [--ai claude|codex|agy] [--force]

Supported sources: .pdf, .docx, .txt, .md, .json, and any UTF-8 text file. (Legacy .doc — export to PDF/DOCX/TXT first.)

$ resumable import --from old_resume.pdf
$ resumable import --from cv.docx --out .config/user_data.json

templates

List available design templates with status (✓/✗), or manage customization via subcommands.

resumable templates [set | import | eject <name>]

Subcommands

• set — Interactive checklist to enable or disable templates.
• import — Extract visual style from a URL or file path (image/text document) into .config/custom.css. Includes a guardrail that validates the source has resume-like content, and allows a custom instructions prompt to guide the AI for precise styling corrections.
• eject <name> — Eject a built-in template's CSS stylesheet to customize it.

$ resumable templates
Available templates:

  ✗ classic      Traditional serif, centered header — safe for any industry
  ✗ modern       Clean sans-serif with a blue accent — tech / startup
  ✗ minimal      Airy, light weights, lots of whitespace
  ✗ two-column   Two-column layout with a dark sidebar
  ✗ elegant      Serif headings over a sans body, warm accent rule
  ✓ compact      Dense layout for maximizing content per page

Configuration

resumable init writes .config/resumable.config.json:

{
  "resumeData": ".config/user_data.json",
  "templates": {
    "classic": false,
    "modern": false,
    "minimal": false,
    "two-column": false,
    "elegant": false,
    "compact": true,
    "custom": false
  },
  "customTemplate": null,
  "formats": { "markdown" : true, "html": false, "pdf": true },
  "photo": "avatar.png",
  "ai": null
}

Design templates

Six print-optimized CSS themes. Enable any number under templates in the config (each renders its own file), or pass --template <name> to render just one.

Add your own by dropping a .css file in templates/ and registering it in src/templates.rs.

Resume data formats

The resume JSON is auto-detected as either shape:

• camelCase Profile (app shape): top-level personalInfo, education, experience, … — this is what init / import write.
• snake_case seed: top-level profile with full_name, field_of_study, …

App-only fields (ids, completeness, template/photo preferences) are ignored.

Notes & guarantees

• The tailoring prompt forbids fabrication: the model may only reword, reorder, emphasize, or omit the supplied data.
• Markdown output is cleaned (code fences unwrapped, preamble before the first # heading dropped) before writing.
• HTML/PDF are produced from the Markdown wrapped in the chosen template's CSS; the PDF is rendered by a headless Chromium browser.
• Existing output files are not overwritten unless --force is passed.
• Always review resume.md before rendering — the AI can misread your data (wrong emphasis, dropped details, or reworded facts).