Skip to main content

Render resume JSON to print-ready HTML using Jinja templates.

Project description

cv-claw

Render a resume JSON file into a print-ready, self-contained HTML document via Jinja2 templates. The primary user is Claude (or any shell-capable agent): produce JSON, then run one command to hand the user a real artifact — no browser, no dev server required.

A small live-preview dev server is available behind an optional extra.

Install

cv-claw is a standalone CLI. Install it however you manage Python tools:

# pip
pip install cv-claw

# uv (installs the CLI on your PATH, isolated)
uv tool install cv-claw

Either way you get the cv-claw command. To enable the optional live-reload dev server or the PDF backend, install the corresponding extra:

pip install 'cv-claw[serve]'   # cv-claw serve
pip install 'cv-claw[pdf]'     # native PDF export

Quickstart

Write the bundled example resume to start from, then render it:

cv-claw init                  # → writes resume.json (a complete example)
cv-claw render resume.json    # → writes resume.html next to the JSON

cv-claw init won't clobber an existing file — pass a path or --force (cv-claw init my-resume.json). The example is a full, realistic resume exercising every section kind; edit it into your own and re-render.

cv-claw renders whichever path you give it — the JSON can live anywhere. To keep generated HTML out of the way:

cv-claw render path/to/resume.json --output-dir build/
# → writes build/resume.html

Open the HTML in a browser and use the browser's print dialog to export to PDF. classic is the only bundled template; run cv-claw list-templates to see what's available.

CLI

init

cv-claw init [path] [flags]

Write the bundled example resume JSON to path (default resume.json). Refuses to overwrite an existing file unless --force is given. Parent directories are created as needed.

Flag Default Description
[path] resume.json Destination file for the example JSON.
--force off Overwrite an existing file at the destination.

render

cv-claw render <input.json> [flags]

Validate the JSON, look up the template, and write a standalone HTML file. By default the output lands next to the input with an .html suffix.

Flag Default Description
-o, --output <path> <input>.html Single explicit output file. Wins over --output-dir.
--output-dir <dir> Output directory; filename is <input-stem>.html. Directory is created if missing.
--template <name> from JSON Override the template field in the resume JSON for this render only.
--templates-dir <dir> auto-discover Replace the default search roots (workspace + bundled) with a single directory.

list-templates

cv-claw list-templates [flags]

Print discovered template names, one per line. Default output annotates each entry with its source: (workspace) for templates under ./.cvclaw/templates/, (bundled) for those shipped inside cv-claw.

Flag Default Description
--templates-dir <dir> auto-discover Replace the default search roots with a single directory; drops the source annotation.

validate

cv-claw validate <input.json>

Run schema validation only. Exits 0 on success, non-zero on failure. Useful as a sanity check before rendering.

serve

cv-claw serve [flags]

Run a small live-reload dev server. Requires the optional [serve] extra (uv sync --all-extras or pip install 'cv-claw[serve]').

Flag Default Description
--host <addr> 127.0.0.1 Host to bind to.
-p, --port <int> 8000 Port to listen on.
--resumes-dir <dir> CWD Directory of resume JSON files to serve.
--templates-dir <dir> auto-discover Replace the default template search roots with a single dir.

Global

Flag Description
--version Show version and exit.

Schema

A resume is a JSON document with a template, a header, and a list of sections. Each section is one of four kinds — prose, keyvalue, list, or timeline — and is dispatched to the matching renderer in the template.

Using the skill in your own workspace

The skills/cv-claw/ directory ships a single Agent Skill covering three resume tasks — ingest (PDF/image/text → JSON), tailor (adapt for a job description), and create-template (new Jinja2 layout). The main SKILL.md stays small; each task lives under references/ and is loaded on demand.

To use:

  1. Install cv-claw in your workspace: uv add cv-claw (or pip install cv-claw).
  2. Copy skills/cv-claw/ into your workspace's skills directory.
  3. Point your agent at it and start producing resume JSON.

Templates

Templates live in two roots, both auto-discovered:

  1. Bundled — ship inside the cv-claw package (e.g. classic). Read-only; they come down with pip install cv-claw.
  2. Workspace — under ./.cvclaw/templates/<name>/ in your current working directory. Optional; created on first use by the skill.

A workspace template shadows a bundled template of the same name — that's the supported way to fork. The .cvclaw/ prefix is reserved for cv-claw workspace state; today it holds templates/, and future versions may add cache or config under the same prefix.

A typical workspace tree:

my-resume-workspace/
├── resumes/                       # or wherever you keep your JSON
│   └── default.json
└── .cvclaw/
    └── templates/
        └── minimalist/
            ├── minimalist.html.j2 # entry point
            ├── minimalist.css     # inlined into the rendered HTML
            └── _macros.html.j2    # optional section renderers

Files and directories starting with _ are treated as partials and are skipped by template discovery. Add a new template by dropping in a new folder with the same shape (the create-template task automates the scaffolding).

Resume JSON conventions

cv-claw doesn't impose a directory for your resume JSON — pass any path on the CLI and it just works. The bundled skill (used by Claude Code and other agent surfaces) asks the user once where resume JSON should live and can record the answer in your workspace CLAUDE.md under a ## cv-claw: resume location heading so future sessions don't re-ask.

Development

make install     # uv sync --all-extras
make lint        # ruff check
make format      # ruff format
make check       # ruff check + ruff format --check
make render      # render resumes/example.json
make clean       # remove caches and build artifacts

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cv_claw-0.1.1.tar.gz (14.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cv_claw-0.1.1-py3-none-any.whl (17.5 kB view details)

Uploaded Python 3

File details

Details for the file cv_claw-0.1.1.tar.gz.

File metadata

  • Download URL: cv_claw-0.1.1.tar.gz
  • Upload date:
  • Size: 14.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for cv_claw-0.1.1.tar.gz
Algorithm Hash digest
SHA256 9deaaadba27dc58cba1ee96d7d6d1e0c7b0b1f32bc82949e87f26a625be9ccf9
MD5 b8bb00279ff539f51320487fae982fd3
BLAKE2b-256 8df34f899ba80f2225e0bfa4cd1b12ac3a5367bbb68d7e9b243e796c5dd7b697

See more details on using hashes here.

Provenance

The following attestation bundles were made for cv_claw-0.1.1.tar.gz:

Publisher: release.yml on farhan0167/cv-claw

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cv_claw-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: cv_claw-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 17.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for cv_claw-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 354dedb82e7e44ced96d09f646053d4a33e24b72451c8e6cb2b3cfa44f7979f7
MD5 33b3e79bcc23a501dc6ff25b6b0a114d
BLAKE2b-256 c66745e7bfd21c0d2f33cd2c2279aff4ccedbae50245f6401fc5411369490526

See more details on using hashes here.

Provenance

The following attestation bundles were made for cv_claw-0.1.1-py3-none-any.whl:

Publisher: release.yml on farhan0167/cv-claw

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page