Create Pull Request CLI

A CLI tool that automatically generates pull request descriptions based on Jira tickets and file changes using AI providers (Claude, OpenAI, Gemini, or GitHub Copilot).

Features

🎫 Jira Integration: Automatically fetches ticket information from Jira
📄 Confluence Integration: Optionally includes linked Confluence pages in PR description generation
🔄 Git Analysis: Analyzes file changes and commit history
🤖 AI-Powered: Uses your selected AI provider (Claude, OpenAI, Gemini, or Copilot) to generate intelligent PR descriptions
📋 Template Support: Automatically detects and uses PR templates from your repository
✅ User Review: Always asks for user confirmation before creating the PR
🏃‍♂️ Dry Run Mode: Preview generated content without creating a PR

Installation

Global Installation

npm install -g publish-pull-request

Local Installation

npm install publish-pull-request

Setup

Option 1: Interactive Setup (Recommended)

create-pr setup

This will guide you through setting up all required credentials and AI providers.

Option 2: Manual Setup

Copy the environment example file:
```
cp .env.example .env
```

Configure your credentials in .env:

# Jira Configuration
JIRA_BASE_URL=https://your-company.atlassian.net
JIRA_USERNAME=your-email@company.com
JIRA_API_TOKEN=your-jira-api-token

# GitHub Configuration
GITHUB_TOKEN=your-github-personal-access-token

# AI Providers (at least one required)
# Primary: Anthropic Claude (recommended)
CLAUDE_API_KEY=your-claude-api-key
CLAUDE_MODEL=claude-3-5-sonnet-20241022

# Secondary: OpenAI (ChatGPT)
OPENAI_API_KEY=your-openai-api-key
OPENAI_MODEL=gpt-4o

# Fallback: Google Gemini
GEMINI_API_KEY=your-gemini-api-key
GEMINI_MODEL=gemini-1.5-pro

# Legacy: GitHub Copilot
COPILOT_API_TOKEN=your-copilot-api-token

Getting API Keys

Jira API Token:

Go to Atlassian Account Settings
Create a new API token
Copy the token to your configuration

GitHub Token:

Go to GitHub Settings > Developer settings > Personal access tokens
Generate a new token with repo permissions
Copy the token to your configuration

Anthropic Claude API Key (Recommended):

Go to Anthropic Console
Create a new API key
Copy the key to your configuration

OpenAI API Key (Secondary):

Go to OpenAI API Keys
Create a new secret key
Copy the key to your configuration

Google Gemini API Key (Fallback):

Go to Google AI Studio
Create a new API key
Copy the key to your configuration

GitHub Copilot API Token (Legacy):

Uses the same token as GitHub API
Or get a separate Copilot API token if available

Usage

Basic Usage

# Create a PR for a Jira ticket
create-pr create --jira PROJ-123

# Interactive mode (will prompt for ticket)
create-pr create

# Specify base branch (default: main)
create-pr create --jira PROJ-123 --base develop

# Custom title
create-pr create --jira PROJ-123 --title "Custom PR Title"

# Dry run (preview without creating)
create-pr create --jira PROJ-123 --dry-run

Available Commands

create-pr create - Create a pull request with auto-generated description
create-pr setup - Interactive setup wizard for credentials and AI providers
create-pr config - Show configuration setup instructions
create-pr --help - Show help information

Options

-j, --jira <ticket> - Jira ticket ID (e.g., PROJ-123)
-b, --base <branch> - Base branch for the pull request (default: main)
-t, --title <title> - Custom pull request title
--dry-run - Generate description without creating PR

How It Works

Validation: Checks that you're in a git repository and have proper configuration
Jira Integration: Fetches ticket details including summary, description, and metadata
Confluence Check: Optionally fetches linked Confluence pages after user confirmation
Git Analysis: Analyzes file changes, commit messages, and diff content
Template Detection: Looks for PR templates in your repository
AI Provider Selection: Uses the configured AI provider or prompts you to select one if multiple are available
AI Generation: Uses the selected AI provider to generate intelligent descriptions
User Review: Shows generated content and asks for confirmation
PR Creation: Creates the pull request on GitHub

Confluence Integration

When a Jira ticket has linked Confluence pages, the tool will ask if you want to include their content in the PR description generation:

✔ Jira ticket information fetched
🎫 Using Jira ticket: PROJ-123 - Implement user authentication

⠋ Checking for linked Confluence pages...
✔ Found linked Confluence pages
? Include Confluence page content in PR summary generation? (y/N)

Benefits

Enhanced Context: AI uses documented requirements and specifications from Confluence
Better Alignment: Generated descriptions reference relevant documentation
Smarter Summaries: AI can cross-reference code changes with documented requirements
User Control: You decide whether to include Confluence content (defaults to No)

How It Works

Detection: Detects Confluence pages linked to your Jira ticket
User Prompt: Asks for confirmation before fetching (defaults to No for faster workflow)
Content Extraction: If confirmed, fetches and processes Confluence page content
Smart Compression: Automatically compresses content to optimize AI prompts
AI Integration: AI uses both Jira and Confluence context to generate better descriptions

Supported Confluence URLs

Old-style: /pages/viewpage.action?pageId=123456
New-style: /spaces/SPACE/pages/123456/Page+Title
Wiki URLs: Automatically detected

Configuration

No additional configuration needed! Confluence integration uses your existing Jira credentials:

Same authentication as Jira
No extra API tokens required
Automatic client initialization

Content Processing

HTML Stripping: Removes HTML tags while preserving text content
Smart Compression: Limits content to 2000 characters per page
Intelligent Truncation: Breaks at sentence boundaries for better readability
Page Limit: Maximum 5 Confluence pages per ticket

Example with Confluence

✔ Found linked Confluence pages
? Include Confluence page content in PR summary generation? Yes
⠋ Fetching Confluence pages content...
✔ Loaded 2 Confluence page(s)
📄 Confluence pages found:
   • Authentication Requirements
   • API Security Guidelines

⠋ Analyzing repository and changes...
✔ Repository: company/awesome-app, Branch: feature/auth-implementation

The AI will then generate a PR description that references and aligns with the documented requirements from these Confluence pages.

AI Provider Options

The tool supports the following AI providers:

Claude (Anthropic) - Recommended
- Most reliable and consistent results
- Excellent code understanding and analysis
- Superior reasoning capabilities for complex changes
- Fast response times
OpenAI (ChatGPT) - Alternative
- Reliable option with good code understanding
- Good understanding of code context
- Consistent performance
Gemini (Google) - Alternative
- Strong analytical capabilities
- Handles complex code changes well
- Good alternative option
GitHub Copilot - Legacy option
- May have stability issues
- Uses GitHub infrastructure
- Available for existing setups

Provider Selection:

If only one provider is configured, it will be used automatically
If multiple providers are available, the tool will use the priority order: Claude → OpenAI → Gemini → Copilot
You can configure multiple providers, but the tool will not automatically fall back if your selected provider fails
If your selected provider fails, you'll get a clear error message and need to ensure it's properly configured

Supported PR Template Locations

The tool automatically detects PR templates from these locations:

.github/pull_request_template.md
.github/PULL_REQUEST_TEMPLATE.md
pull_request_template.md
PULL_REQUEST_TEMPLATE.md
.github/PULL_REQUEST_TEMPLATE/default.md
.github/PULL_REQUEST_TEMPLATE/*.md (multiple templates)

Example Output

🚀 Starting pull request creation process...

✔ Jira ticket information fetched
🎫 Using Jira ticket: PROJ-123 - Implement user authentication

⠋ Checking for linked Confluence pages...
✔ Found linked Confluence pages
? Include Confluence page content in PR summary generation? Yes
⠋ Fetching Confluence pages content...
✔ Loaded 2 Confluence page(s)
📄 Confluence pages found:
   • Authentication Requirements
   • API Security Guidelines

⠋ Analyzing repository and changes...
✔ Repository: company/awesome-app, Branch: feature/auth-implementation

📊 Changes Summary:
   Files changed: 8
   Insertions: +245
   Deletions: -12

✅ Using PR template: default.md
✅ Code analysis complete
✅ Pull request description generated

📝 Generated Pull Request:
Title: PROJ-123: Implement user authentication

Description:
## Summary
This PR implements user authentication functionality as specified in PROJ-123,
following the requirements documented in the Authentication Requirements and
API Security Guidelines Confluence pages...

? What would you like to do? 
❯ ✅ Create the pull request
  ✏️  Edit the description  
  ❌ Cancel

✅ Pull request created successfully!

🎉 Pull Request Created:
URL: https://github.com/company/awesome-app/pull/42
Number: #42
Title: PROJ-123: Implement user authentication

Requirements

Node.js 18.0.0 or higher (ES2021 support)
Git repository
Jira account with API access
GitHub account with repository access
At least one AI provider:
- Anthropic Claude API key (recommended) - Most reliable and intelligent
- OpenAI API key (alternative) - Reliable option
- Google Gemini API key (alternative) - Good option
- GitHub Copilot API token (legacy) - May have availability issues
Optional: Confluence pages linked to Jira tickets (uses same Jira credentials)

Development

# Clone the repository
git clone https://github.com/doraemon0905/create-pull-request.git
cd create-pull-request

# Install dependencies
npm install

# Build the project
npm run build

# Run in development mode
npm run dev

# Run tests
npm test

# Lint code
npm run lint

Technical Specifications

TypeScript Target: ES2021 for modern JavaScript features
Node.js Modules: Uses node: prefix for built-in modules (node:fs, node:path, etc.)
Code Style: Modern JavaScript practices including for...of loops and String#replaceAll()
AI Provider Architecture: Direct provider selection without automatic fallbacks for predictable behavior

Contributing

Fork the repository
Create your feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Troubleshooting

Common Issues

Authentication Error: Make sure your Jira and GitHub tokens are correct and have proper permissions
Template Not Found: PR templates are optional. The tool will use a default format if none are found
No Changes Detected: Make sure you're on a feature branch with changes compared to the base branch
AI Provider Issues:
- The tool will not automatically fall back to other providers if your selected provider fails
- Ensure your selected AI provider has a valid API key and proper configuration
- If you need reliability, ensure your primary provider is properly set up
- Run create-pr setup to configure or change AI providers
No AI Providers Configured: At least one AI provider must be configured. Run create-pr setup to configure providers

Getting Help

Run create-pr setup for interactive setup wizard
Run create-pr config for manual setup instructions
Check that all environment variables are set correctly
Ensure you're in a git repository with a GitHub origin remote
Verify at least one AI provider is properly configured

Support

If you encounter any issues or have questions, please open an issue on GitHub.

Name		Name	Last commit message	Last commit date
Latest commit History 244 Commits
.github		.github
bin		bin
lib		lib
scripts		scripts
src		src
.env.example		.env.example
.eslintrc.cjs		.eslintrc.cjs
.gitignore		.gitignore
.npmrc		.npmrc
LICENSE		LICENSE
PUBLISHING.md		PUBLISHING.md
README.md		README.md
eslint.config.js		eslint.config.js
git-create-pr		git-create-pr
jest.config.cjs		jest.config.cjs
package-lock.json		package-lock.json
package.json		package.json
sonar-project.properties		sonar-project.properties
tsconfig.json		tsconfig.json

Uh oh!

License

Vibe-Code-Agent/create-pull-request

Folders and files

Latest commit

History

Repository files navigation

Create Pull Request CLI

Features

Installation

Global Installation

Local Installation

Setup

Option 1: Interactive Setup (Recommended)

Option 2: Manual Setup

Getting API Keys

Usage

Basic Usage

Available Commands

Options

How It Works

Confluence Integration

Benefits

How It Works

Supported Confluence URLs

Configuration

Content Processing

Example with Confluence

AI Provider Options

Supported PR Template Locations

Example Output

Requirements

Development

Technical Specifications

Contributing

License

Troubleshooting

Common Issues

Getting Help

Support

Sonarcloud Report

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 38

Sponsor this project

Uh oh!

Packages 0

Uh oh!

Contributors 4

Uh oh!

Languages

Packages