promoteme

Crates.iopromoteme
lib.rspromoteme
version0.1.0
created_at2026-01-20 23:52:58.532476+00
updated_at2026-01-20 23:52:58.532476+00
descriptionCLI tool that generates brag documents from your contributions
homepage
repositoryhttps://github.com/g4rcez/promoteme
max_upload_size
id2057867
size121,012
Allan Garcez (g4rcez)

documentation

README

promoteme

A CLI that helps you write brag documents by analyzing your GitHub contributions.

Features

  • Automatic PR fetching via GitHub CLI
  • Repository grouping and analysis
  • AI-powered document generation (Claude/Gemini)
  • Multi-language output support
  • Personal notes integration
  • Date range filtering
  • Organization and repository filtering

Prerequisites

Installation

Via Cargo (crates.io)

cargo install promoteme

From source

git clone https://github.com/g4rcez/promoteme
cd promoteme
cargo install --path .

Usage

promoteme generate [OPTIONS]

Options:
  --start-date    Start date YYYY-MM-DD (default: 6 months ago)
  --end-date      End date YYYY-MM-DD (default: today)
  --org           Filter by organization(s), comma-separated
  --repo          Filter by repo(s), format: owner/repo
  -l, --language  Output language (English, Portuguese, etc.)
  -m, --model     AI model: claude (default), gemini. Use cli@model format for specific model.
  --notes         Directory with personal notes (.md/.txt)

Examples

Basic usage (last 6 months):

promoteme generate

With date filters:

promoteme generate --start-date 2024-01-01 --end-date 2024-06-30

Filter by organization:

promoteme generate --org my-company

Filter by specific repositories:

promoteme generate --repo owner/repo1 --repo owner/repo2

Output in Portuguese:

promoteme generate -l Portuguese

Using Claude instead of Gemini:

promoteme generate -m claude

Using specific model:

promoteme generate -m claude@claude-opus-4-5

Include personal notes:

promoteme generate --notes ~/my-notes

Tech stack

What is a Brag Document?

A brag document is a running record of your professional accomplishments. It serves as a personal changelog of your work contributions.

When to use

  • Performance reviews
  • Promotion discussions
  • Job interviews
  • Salary negotiations
  • Updating your resume

Tips for maintaining one

  • Update it regularly (weekly or bi-weekly)
  • Include quantifiable impact when possible
  • Document both technical and non-technical contributions
  • Keep it factual and specific

What to include

  • Pull requests and code contributions
  • Code reviews and mentoring
  • Documentation improvements
  • Bug fixes and incidents resolved
  • Process improvements
  • Cross-team collaboration
  • Knowledge sharing and presentations

References

Commit count: 6

cargo fmt