run-cv

A mainframe-inspired terminal CV viewer built with Node.js, React, and Ink.

View Landing Page

• 📟 Retro Terminal UI: Green-screen aesthetic with keyboard navigation.
• 📝 Markdown Driven: CV content is managed entirely via Markdown files.
• 📂 Multi-Human Support: Easily switch between different profiles.

• 📟 MacOS/Linux: Just run npx run-cv
• 🪟 Windows: Ensure Node.js is installed, then run npx run-cv in your terminal.

npx run-cv <name>

To run the project locally:

pnpm install
pnpm run dev
# or for a specific profile
pnpm run dev <name>

To run the CV for a specific human:

pnpm run dev <name>

1. Create a folder in src/humans/<name>.
2. Create an introduction.md file. This acts as the manifest and entry point. (PDF generator now reads from this file; pdf-intro.md is deprecated.)
   • Frontmatter may include a skills: field (comma-separated) and you can place <!-- Skills badges --> somewhere in the body to have them rendered as retro badges in the terminal and as styled labels above the intro text in the PDF.

---
name: Your Name
role: Your Role
menu:
  - label: Work Experience
    file: experience/index.md
  - label: Contact
    file: contact.md
---

# SYSTEM ONLINE

Welcome to the terminal.

3. Add the referenced markdown files (e.g., experience.md, contact.md) in the same folder.

You can generate a PDF version of a CV using the gen-pdf script. It will include the text from introduction.md at the top; separate pdf-intro.md files are no longer required.

pnpm run gen-pdf <name> [-- --theme <theme-name>]

• <name>: The name of the human.
• --theme <theme-name>: (Optional) Specify a theme. Defaults to vintage.

A companion utility, gen-json, will export the same CV content as a plain JSON file (frontmatter plus markdown body). It ignores any UI/menu fields so you can consume it from other tools.

pnpm run gen-json <name> [-- --all]

Available themes:

• vintage
• terminal

Each theme supports a handful of CSS variables you can tweak in styles/themes/<theme>/base.css. A new variable --list-item-spacing controls vertical distance between <li> elements (default 1 mm), so PDFs render without excessive gaps.

Example:

# Generate a PDF for <name> with the 'terminal' theme
  pnpm run gen-pdf <name> -- --theme terminal

We use Semantic Versioning (SemVer) to manage releases. Instead of manually editing package.json, use the following automated workflow to ensure the repository tags and the NPM registry remain perfectly in sync.

Decide which part of the version number ($X.Y.Z$) to increment based on your changes:

Note: These commands automatically update package.json and pnpm-lock.yaml, create a git commit, and generate a git tag.

Example:

pnpm version patch -m "Release v%s: Fixed header spacing and updated blah theme"

git push origin main --follow-tags

pnpm login
pnpm publish

Go to the Releases tab on GitHub.

Click Draft a new release.

Select the Tag you just pushed (e.g., v0.0.6).

Click Generate release notes to automatically pull in your commit history.

Click Publish release