gitpt 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 @bartaxyz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,103 @@
+# GitPT
+
+Git Prompt Tool is a CLI tool that helps you write commit messages using AI through [OpenRouter](https://openrouter.ai/).
+
+## Features
+
+- Generate commit messages with AI based on your code changes
+- Compatible with all regular git commit options (you can treat it as an alias)
+- Edit suggested messages before committing
+- Works with various AI models via OpenRouter
+
+## Installation
+
+```bash
+# Install globally
+npm install -g gitpt
+
+# Or use npx
+npx gitpt
+```
+
+## Set up
+
+To configure GitPT with your OpenRouter API key and select a model:
+
+```bash
+gitpt setup
+```
+
+This will guide you through:
+1. Entering your OpenRouter API key
+2. Selecting an AI model from popular options or specifying a custom one
+
+You'll need an [OpenRouter](https://openrouter.ai/) account to get an API key.
+
+## Usage
+
+### Adding Files
+
+Add files to the staging area using either git directly or the GitPT wrapper:
+
+```bash
+# Standard git command
+git add .
+
+# Or using GitPT wrapper
+gitpt add .
+```
+
+### Creating Commits
+
+Generate an AI-powered commit message based on your staged changes:
+
+```bash
+gitpt commit
+```
+
+The tool will:
+1. Analyze your staged changes
+2. Generate a commit message using the configured AI model
+3. Show you the suggested message
+4. Let you edit the message before committing
+5. Create the commit with your approved message
+
+### Options
+
+You can use any standard git commit options with the `gitpt commit` command:
+
+```bash
+# Skip editing the message
+gitpt commit --no-edit
+
+# Provide your own message instead of generating one
+gitpt commit -m "Your message here"
+
+# Pass any other git commit options
+gitpt commit --amend
+```
+
+## How It Works
+
+GitPT sends a diff of your staged changes to the configured AI model via OpenRouter, which generates a contextual commit message following best practices.
+
+## Development
+
+```bash
+# Clone the repository
+git clone https://github.com/bartaxyz/GitPT.git
+cd GitPT
+
+# Install dependencies
+npm install
+
+# Build the project
+npm run build
+
+# Link for local development
+npm link
+```
+
+## License
+
+MIT

package/dist/commands/add.d.ts

@@ -0,0 +1 @@
+export declare function addCommand(files: string[]): void;

package/dist/commands/add.js

@@ -0,0 +1,16 @@
+import chalk from 'chalk';
+import { isGitRepository, executeGitAdd } from '../utils/git.js';
+export function addCommand(files) {
+    if (!isGitRepository()) {
+        console.error(chalk.red('Error: Not a git repository'));
+        process.exit(1);
+    }
+    try {
+        executeGitAdd(files);
+        console.log(chalk.green('Files added to staging area'));
+    }
+    catch (error) {
+        console.error(chalk.red('Error:'), error instanceof Error ? error.message : String(error));
+        process.exit(1);
+    }
+}

package/dist/commands/commit.d.ts

@@ -0,0 +1,7 @@
+interface CommitOptions {
+    message?: string;
+    edit?: boolean;
+    [key: string]: any;
+}
+export declare function commitCommand(options: CommitOptions): Promise<void>;
+export {};

package/dist/commands/commit.js

@@ -0,0 +1,74 @@
+import inquirer from 'inquirer';
+import chalk from 'chalk';
+import { isGitRepository, hasStagedChanges, getStagedChanges, executeGitCommit } from '../utils/git.js';
+import { generateCommitMessage } from '../utils/api.js';
+import { getConfig } from '../utils/config.js';
+export async function commitCommand(options) {
+    if (!isGitRepository()) {
+        console.error(chalk.red('Error: Not a git repository'));
+        process.exit(1);
+    }
+    // Check if config exists
+    const config = getConfig();
+    if (!config) {
+        console.error(chalk.red('GitPT is not configured. Please run "gitpt setup" first.'));
+        process.exit(1);
+    }
+    // Check if there are staged changes
+    if (!hasStagedChanges()) {
+        console.error(chalk.yellow('No staged changes. Use "git add" or "gitpt add" to stage changes first.'));
+        process.exit(1);
+    }
+    let commitMessage;
+    // If message is provided, use that
+    if (options.message) {
+        commitMessage = options.message;
+    }
+    else {
+        try {
+            // Get staged changes
+            const diff = getStagedChanges();
+            console.log(chalk.blue('Generating commit message...'));
+            // Generate commit message
+            commitMessage = await generateCommitMessage(diff);
+            console.log(chalk.green('✓ Commit message generated'));
+            console.log('');
+            console.log(chalk.cyan('Generated message:'));
+            console.log(commitMessage);
+            console.log('');
+        }
+        catch (error) {
+            console.error(chalk.red('Error:'), error instanceof Error ? error.message : String(error));
+            process.exit(1);
+        }
+    }
+    // If edit is true or not specified, prompt user to edit the message
+    if (options.edit !== false) {
+        const answer = await inquirer.prompt([
+            {
+                type: 'editor',
+                name: 'message',
+                message: 'Edit commit message:',
+                default: commitMessage
+            }
+        ]);
+        commitMessage = answer.message;
+    }
+    // Extract other git options to pass through
+    const gitOptions = Object.keys(options)
+        .filter(key => !['message', 'edit'].includes(key))
+        .map(key => {
+        if (typeof options[key] === 'boolean') {
+            return options[key] ? `--${key}` : `--no-${key}`;
+        }
+        return `--${key}=${options[key]}`;
+    });
+    try {
+        executeGitCommit(commitMessage, gitOptions);
+        console.log(chalk.green('✓ Changes committed successfully'));
+    }
+    catch (error) {
+        console.error(chalk.red('Error:'), error instanceof Error ? error.message : String(error));
+        process.exit(1);
+    }
+}

package/dist/commands/setup.d.ts

@@ -0,0 +1 @@
+export declare function setupCommand(): Promise<void>;

package/dist/commands/setup.js

@@ -0,0 +1,60 @@
+import inquirer from 'inquirer';
+import chalk from 'chalk';
+import { saveConfig, clearConfig } from '../utils/config.js';
+// List of popular models available on OpenRouter
+const POPULAR_MODELS = [
+    { name: 'Claude 3 Opus - Anthropic', value: 'anthropic/claude-3-opus:beta' },
+    { name: 'Claude 3 Sonnet - Anthropic', value: 'anthropic/claude-3-sonnet:beta' },
+    { name: 'Claude 3 Haiku - Anthropic', value: 'anthropic/claude-3-haiku:beta' },
+    { name: 'GPT-4o - OpenAI', value: 'openai/gpt-4o' },
+    { name: 'GPT-4 Turbo - OpenAI', value: 'openai/gpt-4-turbo' },
+    { name: 'GPT-3.5 Turbo - OpenAI', value: 'openai/gpt-3.5-turbo' },
+    { name: 'Other (specify model identifier)', value: 'custom' }
+];
+export async function setupCommand() {
+    console.log(chalk.blue('GitPT Setup'));
+    console.log('This will configure GitPT to use OpenRouter for generating commit messages.');
+    console.log('If you don\'t have an OpenRouter account yet, sign up at https://openrouter.ai');
+    console.log('');
+    const answers = await inquirer.prompt([
+        {
+            type: 'input',
+            name: 'apiKey',
+            message: 'Enter your OpenRouter API key:',
+            validate: (input) => {
+                if (!input)
+                    return 'API key is required';
+                return true;
+            }
+        },
+        {
+            type: 'list',
+            name: 'modelChoice',
+            message: 'Select an AI model:',
+            choices: POPULAR_MODELS
+        },
+        {
+            type: 'input',
+            name: 'customModel',
+            message: 'Enter model identifier:',
+            when: (answers) => answers.modelChoice === 'custom',
+            validate: (input) => {
+                if (!input)
+                    return 'Model identifier is required';
+                return true;
+            }
+        }
+    ]);
+    // Clear existing config before saving new one
+    clearConfig();
+    // Save the new configuration
+    const model = answers.modelChoice === 'custom' ? answers.customModel : answers.modelChoice;
+    saveConfig({
+        apiKey: answers.apiKey,
+        model: model
+    });
+    console.log(chalk.green('✓ GitPT configuration saved successfully'));
+    console.log(`Model set to: ${chalk.yellow(model)}`);
+    console.log('');
+    console.log(`Use ${chalk.cyan('gitpt commit')} to create commits with AI-generated messages.`);
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/index.js

@@ -0,0 +1,48 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import chalk from 'chalk';
+import { setupCommand } from './commands/setup.js';
+import { commitCommand } from './commands/commit.js';
+import { addCommand } from './commands/add.js';
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const packageJson = JSON.parse(fs.readFileSync(path.join(__dirname, '../package.json'), 'utf8'));
+const version = packageJson.version;
+const program = new Command();
+program
+    .name('gitpt')
+    .description('Git Prompt Tool helps you write commit messages using AI')
+    .version(version);
+// Setup command
+program
+    .command('setup')
+    .description('Configure GitPT with your OpenRouter API key and model selection')
+    .action(setupCommand);
+// Add command (pass-through to git add)
+program
+    .command('add [files...]')
+    .description('Add files to git staging area (pass-through to git add)')
+    .action(addCommand);
+// Commit command
+program
+    .command('commit')
+    .description('Generate AI-powered commit message based on staged changes')
+    .option('-m, --message <message>', 'use provided message instead of generating one')
+    .option('-e, --edit', 'edit the message after generation')
+    .option('--no-edit', 'do not edit the message after generation')
+    .allowUnknownOption(true) // Pass through other git commit options
+    .action(commitCommand);
+// Main logic
+async function main() {
+    try {
+        await program.parseAsync();
+    }
+    catch (error) {
+        console.error(chalk.red('Error:'), error instanceof Error ? error.message : String(error));
+        process.exit(1);
+    }
+}
+main();

package/dist/utils/api.d.ts

@@ -0,0 +1 @@
+export declare function generateCommitMessage(diff: string): Promise<string>;

package/dist/utils/api.js

@@ -0,0 +1,55 @@
+import fetch from 'node-fetch';
+import { getConfig } from './config.js';
+const OPENROUTER_API_URL = 'https://openrouter.ai/api/v1/chat/completions';
+export async function generateCommitMessage(diff) {
+    const config = getConfig();
+    if (!config) {
+        throw new Error('GitPT is not configured. Please run "gitpt setup" first.');
+    }
+    const { apiKey, model } = config;
+    const messages = [
+        {
+            role: 'system',
+            content: `You are a helpful assistant that generates concise, informative Git commit messages. 
+      Follow conventional commit style. Be brief but descriptive. 
+      Focus on WHAT changes were made, WHY they were made, and their IMPACT.
+      Use present tense (e.g., "add feature" not "added feature").
+      Split the message like this if needed:
+      
+      feat(scope): short description
+      
+      More detailed explanation if necessary
+      
+      Only include a detailed explanation for complex changes.`
+        },
+        {
+            role: 'user',
+            content: `Generate a commit message for the following git diff:\n\n${diff}`
+        }
+    ];
+    try {
+        const response = await fetch(OPENROUTER_API_URL, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                'Authorization': `Bearer ${apiKey}`,
+                'HTTP-Referer': 'https://github.com/bartaxyz/GitPT',
+            },
+            body: JSON.stringify({
+                model: model,
+                messages: messages,
+                max_tokens: 300,
+            }),
+        });
+        if (!response.ok) {
+            const errorText = await response.text();
+            throw new Error(`API request failed: ${response.status} ${response.statusText}\n${errorText}`);
+        }
+        const data = await response.json();
+        return data.choices[0].message.content.trim();
+    }
+    catch (error) {
+        console.error('Error generating commit message:', error);
+        throw new Error('Failed to generate commit message');
+    }
+}

package/dist/utils/config.d.ts

@@ -0,0 +1,7 @@
+export interface GitPTConfig {
+    apiKey: string;
+    model: string;
+}
+export declare function getConfig(): GitPTConfig | null;
+export declare function saveConfig(newConfig: GitPTConfig): void;
+export declare function clearConfig(): void;

package/dist/utils/config.js

@@ -0,0 +1,24 @@
+import Configstore from 'configstore';
+import chalk from 'chalk';
+const config = new Configstore('gitpt');
+export function getConfig() {
+    try {
+        const apiKey = config.get('apiKey');
+        const model = config.get('model');
+        if (!apiKey || !model) {
+            return null;
+        }
+        return { apiKey, model };
+    }
+    catch (error) {
+        console.error(chalk.red('Error reading configuration:'), error);
+        return null;
+    }
+}
+export function saveConfig(newConfig) {
+    config.set('apiKey', newConfig.apiKey);
+    config.set('model', newConfig.model);
+}
+export function clearConfig() {
+    config.clear();
+}

package/dist/utils/git.d.ts

@@ -0,0 +1,6 @@
+export declare function isGitRepository(): boolean;
+export declare function getStagedChanges(): string;
+export declare function getStagedFiles(): string[];
+export declare function hasStagedChanges(): boolean;
+export declare function executeGitAdd(files: string[]): void;
+export declare function executeGitCommit(message: string, additionalArgs?: string[]): void;

package/dist/utils/git.js

@@ -0,0 +1,62 @@
+import { execSync } from 'child_process';
+import chalk from 'chalk';
+export function isGitRepository() {
+    try {
+        execSync('git rev-parse --is-inside-work-tree', { stdio: 'ignore' });
+        return true;
+    }
+    catch (error) {
+        return false;
+    }
+}
+export function getStagedChanges() {
+    try {
+        return execSync('git diff --staged').toString();
+    }
+    catch (error) {
+        console.error(chalk.red('Error getting staged changes:'), error);
+        throw new Error('Failed to get staged changes');
+    }
+}
+export function getStagedFiles() {
+    try {
+        const result = execSync('git diff --staged --name-only').toString();
+        return result.split('\n').filter(Boolean);
+    }
+    catch (error) {
+        console.error(chalk.red('Error getting staged files:'), error);
+        throw new Error('Failed to get staged files');
+    }
+}
+export function hasStagedChanges() {
+    try {
+        const output = execSync('git diff --staged --quiet || echo "has-changes"').toString();
+        return output.includes('has-changes');
+    }
+    catch (error) {
+        return true; // Assume there are changes if we can't check
+    }
+}
+export function executeGitAdd(files) {
+    try {
+        if (files.length === 0) {
+            throw new Error('No files specified');
+        }
+        const fileArgs = files.join(' ');
+        execSync(`git add ${fileArgs}`, { stdio: 'inherit' });
+    }
+    catch (error) {
+        console.error(chalk.red('Error adding files:'), error);
+        throw new Error('Failed to add files to git');
+    }
+}
+export function executeGitCommit(message, additionalArgs = []) {
+    try {
+        const args = additionalArgs.join(' ');
+        execSync(`git commit -m "${message}" ${args}`, { stdio: 'inherit' });
+    }
+    catch (error) {
+        console.error(chalk.red('Error committing changes:'), error);
+        throw new Error('Failed to commit changes');
+    }
+}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "gitpt",
+  "version": "1.0.0",
+  "description": "CLI tool that helps you write commit messages & pull request descriptions using AI",
+  "main": "dist/index.js",
+  "type": "module",
+  "bin": {
+    "gitpt": "dist/index.js"
+  },
+  "files": [
+    "dist/**/*",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "ts-node --esm src/index.ts",
+    "start": "node dist/index.js",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prepublishOnly": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bartaxyz/GitPT.git"
+  },
+  "keywords": [
+    "git",
+    "ai",
+    "prompt"
+  ],
+  "author": "@bartaxyz",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/bartaxyz/GitPT/issues"
+  },
+  "homepage": "https://github.com/bartaxyz/GitPT#readme",
+  "devDependencies": {
+    "@types/configstore": "^6.0.2",
+    "@types/inquirer": "^9.0.7",
+    "@types/node": "^22.14.1",
+    "@types/node-fetch": "^2.6.12",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3"
+  },
+  "dependencies": {
+    "chalk": "^5.4.1",
+    "commander": "^13.1.0",
+    "configstore": "^7.0.0",
+    "inquirer": "^12.5.2",
+    "node-fetch": "^3.3.2"
+  }
+}