CLI Reference

CommitStudio provides a comprehensive command-line interface (CLI) for analyzing git diffs and managing configurations.

Global Command

The main commitstudio command has the following syntax:

commitstudio [options] [command]
Copy code

Global Options

| Option | Description | |--------|-------------| | -p, --path <path> | Path to the git repository (default: current directory) | | -c, --commits <number> | Number of commits to analyze (default: all) | | -b, --branch <branch> | Branch to analyze (default: current branch) | | --since <date> | Analyze commits since date (e.g., "2023-01-01") | | --author <email> | Filter commits by author email | | --no-cache | Ignore cache and reanalyze all commits | | --dry-run | Run without posting comments to GitHub | | --verbose | Show detailed logs | | --reset | Clear all saved settings and credentials | | -h, --help | Display help information |

Commands

CommitStudio provides several specialized commands:

Standard Mode (Default)

Running commitstudio without a command will execute standard mode, which analyzes git diffs and posts comments to GitHub.

commitstudio [options]
Copy code

Example:

# Analyze last 5 commits on the main branch
commitstudio --commits 5 --branch main

# Analyze commits since Jan 1st, 2023
commitstudio --since "2023-01-01"

# Analyze all commits by a specific author
commitstudio --author "user@example.com"
Copy code

Configuration Mode

The config command allows you to view and update CommitStudio settings.

commitstudio config [options]
Copy code

Options:

• --view: View current configuration settings
• --model <model>: Set AI model to use for analysis (e.g., gpt-4o, gpt-4.1-mini)
• --max-tokens <number>: Set maximum tokens for API requests

Example:

# View current configuration
commitstudio config --view

# Set a specific model
commitstudio config --model gpt-4o

# Set maximum tokens
commitstudio config --max-tokens 3000
Copy code

YOLO Mode

The yolo command allows you to rewrite commit messages using AI.

commitstudio yolo [options]
Copy code

Options:

• Same options as the standard mode, plus:
• --emoji: Add emoji to commit messages (default: true)
• --serious: Generate professional messages without emojis
• --interactive: Confirm each message change individually

Example:

# Rewrite last 5 commit messages with emojis
commitstudio yolo --commits 5

# Rewrite commit messages without emojis
commitstudio yolo --serious

# Preview changes without applying them
commitstudio yolo --dry-run
Copy code

Exit Codes

CommitStudio uses the following exit codes:

| Code | Meaning | |------|---------| | 0 | Success | | 1 | General error | | 2 | Command line parsing error | | 3 | Authentication error | | 4 | Repository detection error | | 5 | API error (OpenAI or GitHub) |

Environment Variables

CommitStudio respects the following environment variables:

| Variable | Description | |----------|-------------| | GITHUB_TOKEN | GitHub personal access token | | OPENAI_API_KEY | OpenAI API key | | GITHUB_CLIENT_ID | GitHub OAuth client ID (optional) | | OPENAI_MODEL | AI model to use for analysis | | OPENAI_MAX_TOKENS | Maximum tokens for API requests |

Advanced Usage

Custom Repository Path

commitstudio --path /path/to/your/repository
Copy code

Verbosity

Use the --verbose flag to see detailed information about the execution process:

commitstudio --verbose
Copy code

Dry Run

Use the --dry-run flag to analyze commits without posting comments to GitHub:

commitstudio --dry-run
Copy code

Related Topics

• JavaScript API - For programmatic usage
• Output Format - Understanding CommitStudio output
• Custom AI Models - Learn about available AI models