Basic Commands
Learn all LazyPR commands and options
Command Structure
The basic LazyPR command structure:
lazypr [target-branch] [options]Or use the short alias:
lzp [target-branch] [options]Target Branch
Specify the branch to compare against (typically main or master):
lazypr main # Compare against main branch (default)
lazypr develop # Compare against develop branch
lazypr master # Compare against master branchIf no branch is specified, LazyPR defaults to main:
lazypr # Same as: lazypr mainCommand Options
-t, --template
Use a PR template from your .github folder.
lazypr main --templateIf multiple templates exist, LazyPR shows an interactive selector.
-l, --locale
Override the language for a single run.
lazypr main -l es # Generate in Spanish
lazypr main -l fr # Generate in French
lazypr main -l ja # Generate in JapaneseSupported languages: en, es, pt, fr, de, it, ja, ko, zh, ru, nl, pl, tr
-c, --context
Provide custom style guidance (max 200 characters) for this run only.
lazypr main -c "Focus on security improvements"
lazypr main -c "Use bullet points and keep it brief"Context overrides your global CONTEXT setting for this run only.
--gh
Generate a GitHub CLI command instead of interactive menu.
lazypr main --ghOutputs a ready-to-run gh pr create command that you can copy and execute.
--no-filter
Include all commits without filtering.
lazypr main --no-filterBy default, LazyPR filters out merge commits, dependency updates, and formatting changes. Use this flag to include everything.
-u, --usage
Display token usage statistics after generation.
lazypr main -uShows the number of tokens consumed by the AI request.
Combining Options
You can combine multiple options:
lazypr main --template -l es -c "Keep descriptions concise" -uThis command:
- Compares against
mainbranch - Uses a PR template
- Generates in Spanish
- Applies custom context
- Shows token usage
Configuration Commands
Manage LazyPR settings:
# Set a configuration value
lazypr config set SETTING_NAME=value
# View all settings
lazypr config list
# View specific setting
lazypr config get SETTING_NAMEHelp Command
View all available commands and options:
lazypr --helpExamples
# Basic usage with main branch
lazypr main
# Use template and show token usage
lazypr main --template -u
# Generate in French with custom guidance
lazypr develop -l fr -c "Emphasize performance improvements"
# Generate GitHub CLI command without filtering
lazypr main --gh --no-filter