Getting Started

DevSum CLI is an AI-powered tool that transforms your git commits into professional accomplishment reports. Get started in minutes.

CLI First

Works directly in your terminal

Fast Setup

Install and configure in seconds

Secure

Your code never leaves your machine

AI-Powered

Multiple AI providers supported

Quick Start

Install DevSum CLI globally and start generating professional commit messages in seconds.

1. Install DevSum CLI

bash

npm install -g @rollenasistores/devsum

2. Configure AI Provider

bash

# Set your API key (example with Gemini)
export GEMINI_API_KEY="your-api-key-here"

# Or use the config command
devsum config set provider gemini
devsum config set apiKey your-api-key-here

3. Generate Your First Commit

bash

# Navigate to your git repository
cd your-project

# Run devsum commit
devsum commit

# Or use the auto workflow
devsum commit --auto

Pro Tip

Use the --auto flag to automatically create a branch, generate a commit message, commit, and push in one command.

Installation

Choose your preferred package manager to install DevSum CLI.

bash

npm install -g @rollenasistores/devsum

Install globally to use the devsum command from anywhere.

System Requirements

Node.js 18+
Required for running the CLI
Git 2.0+
For repository analysis
AI Provider API Key
Gemini, Claude, or OpenAI

Verify Installation

bash

# Check version
devsum --version

# View help
devsum --help

Configuration

Configure DevSum CLI to match your workflow and preferences.

Configuration File

DevSum CLI looks for a .devsumrc.json file in your project root or home directory.

json

{
  "provider": "gemini",
  "model": "gemini-2.0-flash",
  "outputFormat": "markdown",
  "autoCommit": false,
  "autoPush": false,
  "branchPrefix": "feature/",
  "commitStyle": "conventional",
  "maxTokens": 2000,
  "temperature": 0.7
}

Configuration Options

provider

AI provider to use: gemini, claude, or openai

bash

devsum config set provider gemini

model

Specific model to use (e.g., gemini-2.0-flash, claude-3-5-sonnet)

bash

devsum config set model gemini-2.0-flash

outputFormat

Output format: markdown, json, html, or pdf

bash

devsum config set outputFormat markdown

commitStyle

Commit message style: conventional, semantic, or custom

bash

devsum config set commitStyle conventional

Environment variables take precedence over configuration file settings. Use DEVSUM_PROVIDER, GEMINI_API_KEY, etc.

Environment Variables

bash

# AI Provider API Keys
export GEMINI_API_KEY="your-gemini-key"
export ANTHROPIC_API_KEY="your-claude-key"
export OPENAI_API_KEY="your-openai-key"

# Configuration overrides
export DEVSUM_PROVIDER="gemini"
export DEVSUM_MODEL="gemini-2.0-flash"
export DEVSUM_OUTPUT_FORMAT="markdown"

Commands Reference

Complete reference for all DevSum CLI commands and their options.

devsum commitCommand

Generate and create a commit with AI-generated message

Flags & Options

--autoAuto workflow: create branch, commit, and push

--no-verifySkip git hooks

--amendAmend the last commit

--pushAutomatically push after commit

Example

bash

devsum commit --auto

devsum analyzeCommand

Analyze git history and generate accomplishment report

Flags & Options

--since <date>Start date for analysis (e.g., '2024-01-01')

--until <date>End date for analysis

--author <name>Filter by author

--branch <name>Analyze specific branch

--output <file>Save report to file

Example

bash

devsum analyze --since 2024-01-01 --output report.md

devsum reportCommand

Generate formatted report from git history

Flags & Options

--format <type>Output format: markdown, json, html, pdf

--template <name>Use custom template

--group-by <field>Group commits by: date, author, type

Example

bash

devsum report --format pdf --group-by type

devsum configCommand

Manage configuration settings

Flags & Options

set <key> <value>Set configuration value

get <key>Get configuration value

listList all configuration

resetReset to default configuration

Example

bash

devsum config set provider gemini

devsum initCommand

Initialize DevSum CLI in current repository

Flags & Options

--provider <name>Set AI provider during init

--interactiveInteractive setup wizard

Example

bash

devsum init --interactive

AI Providers Setup

DevSum CLI supports multiple AI providers. Choose the one that best fits your needs.

Google Gemini

Fast, cost-effective, and powerful. Recommended for most users.

1. Get API Key

Get Gemini API Key

2. Configure DevSum

bash

export GEMINI_API_KEY="your-api-key-here"
devsum config set provider gemini
devsum config set model gemini-2.0-flash

Available Models

gemini-2.0-flash - Fast and efficient (recommended)
gemini-1.5-pro - More capable, slower

Output Formats

DevSum CLI supports multiple output formats to fit your workflow and reporting needs.

Markdown

Clean, readable format perfect for documentation and README files

Command

bash

devsum report --format markdown

Example Output

markdown

# Accomplishment Report
## January 2024

### Features
- Implemented JWT authentication system
- Added user profile management
- Created admin dashboard

### Bug Fixes
- Fixed memory leak in data processing
- Resolved CORS issues in API

JSON

Structured data format ideal for integrations and automation

Command

bash

devsum report --format json

Example Output

json

{
  "period": "January 2024",
  "commits": 47,
  "features": [
    {
      "title": "JWT Authentication",
      "files": 5,
      "changes": "+440 -20"
    }
  ],
  "bugFixes": 12,
  "totalChanges": "+2847 -456"
}

HTML

Styled web page with interactive elements and charts

Command

bash

devsum report --format html

Example Output

markdown

<!DOCTYPE html>
<html>
<head>
  <title>Accomplishment Report</title>
  <style>/* Beautiful styles */</style>
</head>
<body>
  <h1>Development Summary</h1>
  <div class="stats">...</div>
</body>
</html>

PDF

Professional document ready for performance reviews

Command

bash

devsum report --format pdf

Example Output

markdown

Generates a professionally formatted PDF document with charts, statistics, and detailed commit analysis.

Use Cases

Discover how DevSum CLI can streamline your development workflow and reporting.

Performance Reviews

Generate comprehensive reports of your accomplishments for annual or quarterly reviews

Example Command

bash

devsum analyze --since 2024-01-01 --until 2024-03-31 --format pdf --output q1-review.pdf

Benefits

Quantify your impact
Never forget achievements
Professional formatting

Sprint Summaries

Create detailed sprint reports for standup meetings and retrospectives

Example Command

bash

devsum report --since "2 weeks ago" --group-by type --format markdown

Benefits

Track sprint progress
Identify patterns
Share with team

Project Updates

Keep stakeholders informed with regular project status updates

Example Command

bash

devsum analyze --branch main --since "1 month ago" --format html --output update.html

Benefits

Clear communication
Visual progress
Automated generation

Team Reports

Aggregate team contributions and analyze collaboration patterns

Example Command

bash

devsum report --author "team-member" --since 2024-01-01 --format json

Benefits

Team visibility
Contribution tracking
Data-driven insights

Troubleshooting

Common issues and their solutions to help you get back on track quickly.

Need More Help?

If you encounter an issue not listed here, please open an issue on GitHub or join our community Discord.

API Key Not Found

Ensure your API key is set in environment variables or configuration file

Solution Steps

1.Check if environment variable is set: echo $GEMINI_API_KEY
2.Set the API key: export GEMINI_API_KEY='your-key'
3.Or use config: devsum config set apiKey your-key
4.Verify: devsum config get apiKey

Git Repository Not Found

DevSum CLI must be run inside a git repository

Solution Steps

1.Navigate to your git repository: cd your-project
2.Verify git is initialized: git status
3.If not initialized: git init
4.Try running devsum again

No Changes Detected

Ensure you have staged or unstaged changes in your repository

Solution Steps

1.Check git status: git status
2.Stage changes: git add .
3.Or use --all flag: devsum commit --all
4.Verify changes are present

Rate Limit Exceeded

You've hit the API rate limit for your provider

Solution Steps

1.Wait a few minutes before retrying
2.Check your API provider's rate limits
3.Consider upgrading your API plan
4.Use a different provider temporarily

Enable Debug Mode

For detailed error information, run DevSum CLI with debug logging enabled:

bash

DEBUG=devsum:* devsum commit