Skip to content

Amishk599/cover-me

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🪶 cover-me

✨ Generate professional, personalized cover letters instantly.

cover-me is an AI-powered tool that crafts job-specific cover letters in upload-ready PDF format - using your resume and the job description.

🪄 Copy any job description, run cover-me, and get a tailored cover letter in seconds.

Get Started

1. Installation

🧰 Using pipx (Recommended)

pipx is for installing Python CLI tools like cover-me.


💿 Step 1: Install pipx

# macOS
brew install pipx
pipx ensurepath

# Linux
python -m pip install --user pipx
pipx ensurepath

# Windows
python -m pip install --user pipx
pipx ensurepath

💿 Step 2: Install cover-me

pipx install git+https://github.com/Amishk599/cover-me.git

🔄 Update to Latest Version

pipx upgrade cover-me

2. 🔑 Set Environment Variables

You must provide at least one API key — either OpenAI or Anthropic.

# At least one of the following is required
export OPENAI_API_KEY="your-key"
export ANTHROPIC_API_KEY="your-key"

This will guide you through:

  • Choosing your AI provider (OpenAI or Anthropic)
  • Setting up your API key environment variables
  • Configuring your professional / Resume information
  • Setting output preferences

3. 🚀 Usage

  1. 🗒️ Copy a job description from any website.
  2. 💫 Run the following command in your terminal:
cover-me

Other Commands:

# Configure your settings
cover-me configure

# Edit your professional profile
cover-me profile

# Test your configuration and API connectivity
cover-me test

# Show all options
cover-me --help

⚙️ Configuration Details

All configuration files are stored in:
~/.cover-me/

File Purpose
config.yaml Main application settings — AI provider, output format, and other preferences
profile.md Your professional profile containing experience, skills, and summary
templates/ Folder for PDF templates and visual customizations

You can manually edit these files using any text editor of your choice.


🧱 Requirements

  • Python 3.7+
  • At least one of the following API keys:
    • OPENAI_API_KEY (for OpenAI models)
    • ANTHROPIC_API_KEY (for Anthropic models)

📜 License

This project is licensed under the MIT License.
See the LICENSE file for full details.

About

cover-me is a command-line tool that crafts tailored cover letters in upload-ready PDF format using your resume and a job description in seconds

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors