cvgenx

A CLI tool to generate tailored resumes and cover letters from a job description using Gemini (Google) or OpenAI (ChatGPT).

Requirements

This project requires Node.js v22 or higher.

Installing Node.js v22+ with nvm

If you don't have Node.js v22+ installed, we recommend using nvm (Node Version Manager) to install and manage Node.js versions:

Install nvm (if not already installed):

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
# or
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash

Restart your terminal or run:

source ~/.bashrc
# or
source ~/.zshrc

Install and use Node.js v22:

nvm install 22
nvm use 22
nvm alias default 22

Verify installation:

node --version  # Should show v22.x.x
npm --version

Installation

Quick Start (Recommended)

You can use cvgenx directly with npx without any installation:

npx cvgenx --help

Global Installation

Or install globally from npm:

npm install -g cvgenx

For Contributors Only

Clone the repo only if you want to contribute to the project:

git clone https://github.com/mrh-jishan/cvgenx.git
cd cvgenx
npm install

Configuration

You can store your API keys in either a .env file in your project or a global config at ~/.cvgenx.env.

• GEMINI_API_KEY=your_google_gemini_api_key
• OPENAI_API_KEY=your_openai_api_key

To set up config interactively (with validation and default platform selection), run:

npx cvgenx --auth

• You will be prompted for your Gemini and OpenAI API keys (with validation).
• You can choose your default platform (Gemini or OpenAI) interactively.
• You can re-run this command anytime to update your keys or default platform.

Usage

npx cvgenx <job-description-file.txt> --type <resume|coverLetter|both> [options]

Example:

npx cvgenx job_description.txt --type resume
npx cvgenx job_description.txt --type coverLetter --platform openai
npx cvgenx job_description.txt --type both --user-template my-user.json
npx cvgenx --type both --output-format pdf

If you run npx cvgenx --type both --output-format pdf without specifying a job description file, you will be prompted to paste the job description directly into the terminal. When finished, press Ctrl+D (on Mac/Linux) or Ctrl+Z (on Windows) to submit the input.

User Template Example

To view the default user template in JSON:

npx cvgenx --show-user-template json

To view the default user template in YAML:

npx cvgenx --show-user-template yaml

To save the template to a file for editing:

npx cvgenx --show-user-template json > my-user.json
# or
npx cvgenx --show-user-template yaml > my-user.yaml

Edit the file as needed, then use it with the CLI:

npx cvgenx job.txt --type resume --user-template my-user.json

User Template Management

Interactive Editing

To interactively create or update your default user template:

npx cvgenx --edit-user-template

• This will prompt you for all fields and save the result to ~/.cvgenx.user.json.
• If the file already exists, your current values will be shown and you can update them.

Using an Existing File

To set an existing file as your default user template:

npx cvgenx --edit-user-template my-user.json
# or
npx cvgenx --edit-user-template my-user.yaml

• This will copy the file to your home directory as ~/.cvgenx.user.json (converting from YAML if needed).
• The CLI will always use this file as your default user info.
• Only ~/.cvgenx.user.json is used as the source of truth. No YAML file is created in your home directory.

Showing Your User Template

To view your current default user template in JSON:

npx cvgenx --show-user-template json

To view it in YAML (converted on the fly from JSON):

npx cvgenx --show-user-template yaml

Best Practice

• Keep only one default user template file: The CLI always uses the file at ~/.cvgenx.user.json.
• If you want to switch formats, use the --edit-user-template command with the new file, and the CLI will update your default (always as JSON).
• Avoid editing both files at once; always use the one set as default.

Features

• Loads API keys from either local or home config
• Interactive config setup with --auth (with validation and platform selection)
• Generates resume or cover letter using Gemini or OpenAI
• Supports user info templates in JSON or YAML
• Interactive user template editing (education, projects, summary)

Contributing

Contributions are welcome! To get started:

1. Fork this repository.
2. Create a new branch for your feature or bugfix.
3. Make your changes and add tests if applicable.
4. Run npm test to ensure everything passes.
5. Submit a pull request with a clear description of your changes.

Please follow the existing code style and include relevant documentation updates.

If you have questions or suggestions, feel free to open an issue.

License

MIT