ai-ship-cli 0.1.0-beta.1

package/dist/utils/github.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createGithubPR = void 0;
+const createGithubPR = async ({ title, body, base = 'main', head, }) => {
+    try {
+        await (0, exports.createGithubPR)({ title, body, base, head });
+    }
+    catch (error) {
+        console.error('Failed to create GitHub PR.');
+        throw error;
+    }
+};
+exports.createGithubPR = createGithubPR;

package/dist/utils/helper.js

@@ -0,0 +1,130 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProvider = exports.saveValueToConfig = exports.jsonConfig = exports.verboseConfig = exports.getCurrentConfig = exports.deleteConfigKey = exports.CONFIG_FILE = exports.CONFIG_DIR = exports.log = void 0;
+const os_1 = __importDefault(require("os"));
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const chalk_1 = __importDefault(require("chalk"));
+const ALLOWED_KEYS = ['provider', 'model', 'localEndpoint', 'geminiApiKey'];
+const log = (data) => console.log(data);
+exports.log = log;
+// config dir for storing api key
+exports.CONFIG_DIR = path_1.default.join(os_1.default.homedir(), '.ai-ship');
+// config file for storing api key
+exports.CONFIG_FILE = path_1.default.join(exports.CONFIG_DIR, 'config.json');
+const deleteConfigKey = (key) => {
+    if (!fs_1.default.existsSync(exports.CONFIG_FILE))
+        return false;
+    try {
+        const raw = fs_1.default.readFileSync(exports.CONFIG_FILE, 'utf-8');
+        const config = raw ? JSON.parse(raw) : {};
+        if (config[key]) {
+            delete config[key];
+            fs_1.default.writeFileSync(exports.CONFIG_FILE, JSON.stringify(config, null, 2), 'utf-8');
+            return true;
+        }
+        return false;
+    }
+    catch {
+        return false;
+    }
+};
+exports.deleteConfigKey = deleteConfigKey;
+const getCurrentConfig = (key = 'all') => {
+    if (!fs_1.default.existsSync(exports.CONFIG_FILE))
+        return null;
+    const config = JSON.parse(fs_1.default.readFileSync(exports.CONFIG_FILE, 'utf-8'));
+    if (key === 'all')
+        return config;
+    return config[key];
+};
+exports.getCurrentConfig = getCurrentConfig;
+const verboseConfig = (config) => {
+    const { provider, model, localEndpoint, geminiApiKey } = config;
+    const maskedKey = geminiApiKey
+        ? geminiApiKey.slice(0, 4) + '...' + geminiApiKey.slice(-4)
+        : 'not configured';
+    console.log(chalk_1.default.bold('\nAI-Ship Configuration\n'));
+    console.log(chalk_1.default.yellow('Provider'));
+    console.log('  Current:', provider || 'not set');
+    console.log('  Description: Determines where AI runs (local via Ollama or cloud API)\n');
+    console.log(chalk_1.default.yellow('Model'));
+    console.log('  Current:', model || 'not set');
+    console.log('  Description: AI model used for commit and branch generation\n');
+    console.log(chalk_1.default.yellow('Local Model Settings'));
+    console.log('  Endpoint:', localEndpoint || 'not configured');
+    console.log('  Description: URL of the local model server (e.g. http://127.0.0.1:11434)\n');
+    console.log(chalk_1.default.yellow('Cloud Model Settings'));
+    console.log('  Gemini API Key:', maskedKey);
+    console.log('  Description: API key used when provider is set to cloud\n');
+};
+exports.verboseConfig = verboseConfig;
+const jsonConfig = (config) => {
+    const safeConfig = {
+        provider: config.provider || null,
+        model: config.model || null,
+        localEndpoint: config.localEndpoint || null,
+        geminiApiKey: config.geminiApiKey
+            ? config.geminiApiKey.slice(0, 4) + '...' + config.geminiApiKey.slice(-4)
+            : null,
+    };
+    console.log(JSON.stringify(safeConfig, null, 2));
+};
+exports.jsonConfig = jsonConfig;
+const validateValue = (key, value) => {
+    switch (key) {
+        case 'provider':
+            if (!['local', 'cloud'].includes(value)) {
+                throw new Error("provider must be 'local' or 'cloud'");
+            }
+            break;
+        case 'model':
+            if (typeof value !== 'string' || value.trim().length === 0) {
+                throw new Error('model must be a non-empty string');
+            }
+            break;
+        case 'localEndpoint':
+            try {
+                new URL(value);
+            }
+            catch {
+                throw new Error('localEndpoint must be a valid URL');
+            }
+            break;
+        case 'geminiApiKey':
+            if (typeof value !== 'string' || value.trim().length === 0) {
+                throw new Error('geminiApiKey must be a valid string');
+            }
+            break;
+    }
+};
+const saveValueToConfig = (key, value) => {
+    try {
+        if (!ALLOWED_KEYS.includes(key)) {
+            throw new Error(`Invalid config key: ${key}. Allowed keys: ${ALLOWED_KEYS.join(', ')}`);
+        }
+        validateValue(key, value);
+        if (!fs_1.default.existsSync(exports.CONFIG_DIR)) {
+            fs_1.default.mkdirSync(exports.CONFIG_DIR, { recursive: true });
+        }
+        let config = {};
+        if (fs_1.default.existsSync(exports.CONFIG_FILE)) {
+            const raw = fs_1.default.readFileSync(exports.CONFIG_FILE, 'utf-8');
+            config = raw ? JSON.parse(raw) : {};
+        }
+        config[key] = value;
+        fs_1.default.writeFileSync(exports.CONFIG_FILE, JSON.stringify(config, null, 2), 'utf-8');
+        console.log(chalk_1.default.green(`✔ Config updated: ${chalk_1.default.bold.green(key)}`));
+    }
+    catch (err) {
+        console.error(chalk_1.default.red(`❌ Failed to save config: ${chalk_1.default.bold.red(err.message)}`));
+    }
+};
+exports.saveValueToConfig = saveValueToConfig;
+const getProvider = () => {
+    return (0, exports.getCurrentConfig)('provider');
+};
+exports.getProvider = getProvider;

package/dist/utils/inputs.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.askApiKey = void 0;
+const readline_1 = __importDefault(require("readline"));
+const askApiKey = () => {
+    const rl = readline_1.default.createInterface({
+        input: process.stdin,
+        output: process.stdout,
+    });
+    return new Promise((resolve) => {
+        rl.question('Enter your Gemini API key: ', (answer) => {
+            rl.close();
+            resolve(answer.trim());
+        });
+    });
+};
+exports.askApiKey = askApiKey;

package/dist/utils/inquirer.js

@@ -0,0 +1,79 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.interactivePRPrompt = exports.interactivePushPrompt = exports.interactiveRefinePrompt = void 0;
+const inquirer_1 = __importDefault(require("inquirer"));
+// @ts-ignore
+const enquirer_1 = require("enquirer");
+const chalk_1 = __importDefault(require("chalk"));
+const interactiveRefinePrompt = async (itemType, initialValue) => {
+    const { action } = await inquirer_1.default.prompt([
+        {
+            type: 'list',
+            name: 'action',
+            message: `What would you like to do with this ${itemType}?`,
+            choices: ['Continue', 'Edit', 'Retry', 'Cancel'],
+        },
+    ]);
+    if (action === 'Continue') {
+        return { accepted: true, value: initialValue, cancel: false };
+    }
+    if (action === 'Edit') {
+        const promptInput = new enquirer_1.Input({
+            message: `Edit your ${itemType}:`,
+            initial: initialValue,
+        });
+        const editedValue = (await promptInput.run());
+        return { accepted: true, value: editedValue, cancel: false };
+    }
+    if (action === 'Retry') {
+        console.log(chalk_1.default.yellow(`Retrying ${itemType}...\\n`));
+        return { accepted: false, value: initialValue, cancel: false };
+    }
+    // Cancel
+    console.log(chalk_1.default.yellow(`${itemType.charAt(0).toUpperCase() + itemType.slice(1)} cancelled.\\n`));
+    return { accepted: false, value: initialValue, cancel: true };
+};
+exports.interactiveRefinePrompt = interactiveRefinePrompt;
+const interactivePushPrompt = async () => {
+    const { action } = await inquirer_1.default.prompt([
+        {
+            type: 'list',
+            name: 'action',
+            message: `Do you want to push your committed changes to the remote repository?`,
+            choices: ['Yes', 'No'],
+        },
+    ]);
+    if (action === 'Yes') {
+        return { accepted: true, cancel: false };
+    }
+    console.log(chalk_1.default.yellow(`Push cancelled\n`));
+    return { accepted: false, cancel: true };
+};
+exports.interactivePushPrompt = interactivePushPrompt;
+const interactivePRPrompt = async (defaultBase = 'main') => {
+    const { action } = await inquirer_1.default.prompt([
+        {
+            type: 'list',
+            name: 'action',
+            message: `Do you want to create a pull request?`,
+            choices: ['Yes', 'No'],
+        },
+    ]);
+    if (action === 'Yes') {
+        const { base } = await inquirer_1.default.prompt([
+            {
+                type: 'input',
+                name: 'base',
+                message: `Which branch do you want to target?`,
+                default: defaultBase,
+            },
+        ]);
+        return { accepted: true, cancel: false, base };
+    }
+    console.log(chalk_1.default.yellow(`PR creation cancelled\n`));
+    return { accepted: false, cancel: true, base: defaultBase };
+};
+exports.interactivePRPrompt = interactivePRPrompt;

package/dist/utils/parser.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterNoiseFiles = exports.isNoiseFile = exports.NOISE_PATTERNS = void 0;
+const LOCK_FILES = [
+    '*.lock',
+    'package-lock.json',
+    'yarn.lock',
+    'pnpm-lock.yaml',
+    'Pipfile.lock',
+    'poetry.lock',
+    'Cargo.lock',
+    'composer.lock',
+    'Gemfile.lock',
+    'go.sum',
+];
+const BUILD_DIRS = [
+    'dist/**',
+    'build/**',
+    'out/**',
+    'target/**',
+    'bin/**',
+    'obj/**',
+    '.next/**',
+    '.nuxt/**',
+];
+const CACHE_DIRS = [
+    '.cache/**',
+    '.pytest_cache/**',
+    '.mypy_cache/**',
+    '.gradle/**',
+    '.idea/**',
+    '.vscode/**',
+];
+const DEP_DIRS = ['node_modules/**', 'vendor/**', '.venv/**', 'venv/**'];
+const TEMP_FILES = ['*.log', '*.tmp', '*.temp', '*.swp'];
+const GENERATED_FILES = ['*.map', '*.class', '*.o', '*.pyc', '*.dll', '*.exe'];
+exports.NOISE_PATTERNS = [
+    ...LOCK_FILES,
+    ...BUILD_DIRS,
+    ...CACHE_DIRS,
+    ...DEP_DIRS,
+    ...TEMP_FILES,
+    ...GENERATED_FILES,
+];
+const minimatch_1 = require("minimatch");
+const isNoiseFile = (file) => {
+    return exports.NOISE_PATTERNS.some((pattern) => (0, minimatch_1.minimatch)(file, pattern));
+};
+exports.isNoiseFile = isNoiseFile;
+const filterNoiseFiles = (files) => {
+    const meaningful = files.filter((f) => !(0, exports.isNoiseFile)(f));
+    return meaningful.length ? meaningful : files;
+};
+exports.filterNoiseFiles = filterNoiseFiles;

package/dist/utils/print.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printFileList = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const helper_1 = require("./helper");
+const printFileList = (filesList) => {
+    filesList.forEach(({ status, file }) => {
+        if (status === '??' || status === 'A') {
+            (0, helper_1.log)(chalk_1.default.green(file));
+        }
+        else if (status === 'M') {
+            (0, helper_1.log)(chalk_1.default.yellow(file));
+        }
+        else if (status === 'D') {
+            (0, helper_1.log)(chalk_1.default.red(file));
+        }
+        else {
+            (0, helper_1.log)(file);
+        }
+    });
+};
+exports.printFileList = printFileList;

package/dist/utils/prompts.js

@@ -0,0 +1,206 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pRPrompt = exports.buildBranchPromptGemma = exports.buildCommitPromptGemma = exports.buildBranchPrompt = exports.buildCommitPrompt = void 0;
+const buildCommitPrompt = (summary) => {
+    const formatted = summary
+        .map((s) => `
+File: ${s.file}
++${s.additions} -${s.deletions}
+Signals: ${s.signals.join(', ')}
+
+Snippet:
+${s.snippet.join('\n')}
+`)
+        .join('\n');
+    return `
+Generate a conventional commit message.
+
+Rules:
+- one line
+- under 72 characters
+- conventional commit format
+
+Changes:
+${formatted}
+`;
+};
+exports.buildCommitPrompt = buildCommitPrompt;
+const buildBranchPrompt = (summary, existingBranches, currentBranch, commitMessage) => {
+    const changeList = summary
+        .map((s, i) => {
+        const signals = s.signals.length ? s.signals.join(', ') : 'code change';
+        return `${i + 1}. ${s.file} : ${signals}`;
+    })
+        .join('\n');
+    const branchList = existingBranches.slice(0, 30).join('\n'); // limit tokens
+    return `
+You are a Git expert.
+
+Generate a short git branch name that summarizes the main intent of the change.
+Focus on the most important modification.
+
+Rules:
+- use kebab-case
+- max 40 characters
+- prefix with:
+  feature/
+  fix/
+  refactor/
+  chore/
+  docs/
+- avoid existing branch names
+- return ONLY the branch name
+- no explanation
+- no quotes
+
+Current commit message:
+${commitMessage}
+
+Current branch:
+${currentBranch}
+
+Existing branches:
+${branchList}
+
+Changes:
+${changeList}
+
+Examples:
+feature/add-commit-generator
+fix/git-diff-parser
+refactor/commit-analysis-pipeline
+chore/update-config
+docs/update-readme
+`;
+};
+exports.buildBranchPrompt = buildBranchPrompt;
+const buildCommitPromptGemma = (summary) => {
+    const formatted = summary
+        .map((s) => `
+File: ${s.file}
+Additions: ${s.additions}
+Deletions: ${s.deletions}
+Signals: ${s.signals.join(', ')}
+`)
+        .join('\n');
+    return `
+You generate git commit messages.
+
+Task:
+Write a Conventional Commit message describing the changes.
+
+Rules:
+- one line only
+- under 72 characters
+- imperative tense
+- lowercase commit type
+- no explanation
+- no additional text
+
+Format:
+type: message
+
+Examples:
+feat: add commit generation using AI
+fix: correct git diff parsing
+refactor: simplify diff analyzer logic
+chore: update dependencies
+
+Changes:
+${formatted}
+
+Output exactly one line like:
+feat: add ollama integration
+`;
+};
+exports.buildCommitPromptGemma = buildCommitPromptGemma;
+const buildBranchPromptGemma = (summary, existingBranches, currentBranch, commitMessage) => {
+    const changeList = summary
+        .map((s, i) => {
+        const signals = s.signals.length ? s.signals.join(', ') : 'code change';
+        return `${i + 1}. ${s.file}: ${signals}`;
+    })
+        .join('\n');
+    const branchList = existingBranches.slice(0, 30).join('\n');
+    return `
+You generate git branch names.
+
+Goal:
+Create a concise branch name describing the change.
+
+Rules:
+- kebab-case
+- max 40 characters
+- must start with:
+  feature/
+  fix/
+  refactor/
+  chore/
+  docs/
+- do not match existing branches
+- no explanation
+- no quotes
+
+Commit message:
+${commitMessage}
+
+Current branch:
+${currentBranch}
+
+Existing branches:
+${branchList}
+
+Changed files:
+${changeList}
+
+Output format:
+feature/branch-name
+
+Examples:
+feature/add-commit-generator
+fix/git-diff-parser
+refactor/commit-analysis-pipeline
+chore/update-config
+docs/update-readme
+
+Return ONLY the branch name.
+`;
+};
+exports.buildBranchPromptGemma = buildBranchPromptGemma;
+const pRPrompt = ({ commitMessage, branchName, summary, }) => {
+    return `
+You are an expert software engineer.
+
+Based on the following code changes, generate a high-quality pull request.
+
+Inputs:
+- Commit message: ${commitMessage}
+- Branch name: ${branchName}
+- File changes:
+${JSON.stringify(summary, null, 2)}
+
+Instructions:
+- Write a clear and concise PR title
+- Write a structured PR description
+- Do NOT include unnecessary explanations
+- Do NOT repeat the same information
+- Keep it professional and minimal
+- Keep total description under 120 words
+
+Output format:
+
+TITLE:
+<one-line PR title>
+
+DESCRIPTION:
+## Summary
+<what this PR does>
+
+## Changes
+<bullet list of key changes>
+
+## Notes
+<optional, only if needed>
+`;
+};
+exports.pRPrompt = pRPrompt;

package/dist/utils/runCommit.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const startCommit_1 = __importDefault(require("../commands/commit/startCommit"));
+const git_1 = require("./git");
+exports.default = async (payload) => {
+    console.log({ payload });
+    if (payload?.length) {
+        await (0, git_1.stageFiles)(payload);
+    }
+    else {
+        await (0, git_1.stageAll)();
+    }
+    await (0, startCommit_1.default)();
+};

package/dist/utils/runConfig.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chalk_1 = __importDefault(require("chalk"));
+const helper_1 = require("./helper");
+const inputs_1 = require("./inputs");
+exports.default = async (args) => {
+    // `args` now contains elegantly parsed flags from minimist!
+    // Example: `--model --local connection.json` becomes `{ model: true, local: 'connection.json' }`
+    // Example: `--user-model local` becomes `{ 'user-model': 'local' }`
+    console.log('args');
+    if (args['show']) {
+        console.log('SHOWING');
+        return;
+    }
+    if (args['add-key']) {
+        const apiKey = await (0, inputs_1.askApiKey)();
+        (0, helper_1.saveApiKey)(apiKey);
+        (0, helper_1.log)('API key saved!');
+    }
+    else if (args['delete-key']) {
+        if ((0, helper_1.deleteApiKey)()) {
+            (0, helper_1.log)(chalk_1.default.green('API Key Deleted'));
+        }
+        else {
+            (0, helper_1.log)(chalk_1.default.red('API Key Could Not Be Deleted. API KEY NOT FOUND!'));
+        }
+    }
+    else {
+        (0, helper_1.log)(chalk_1.default.yellow('Unrecognized config option. Here are the extracted args for your logic:'));
+        console.log(args);
+    }
+};

package/docs/commands.md

@@ -0,0 +1,106 @@
+# AI-Ship CLI Commands
+
+AI-Ship is a CLI tool that uses AI + Git diff intelligence to automate commits and branches.
+
+This document outlines all the available commands and flags you can use with the `ai-ship` CLI.
+
+## Core Commands
+
+### `ai-ship commit`
+
+Generates an AI-powered commit message based on your staged Git changes, automatically commits the changes, and optionally generates and checks out a new branch based on the commit context.
+
+AI-Ship analyzes actual Git diffs (not just filenames) to generate context-aware commit messages.
+
+**Usage:**
+
+```bash
+ai-ship commit [file1] [file2] ... [flags]
+```
+
+_Note: If no files are specified, it will stage all changed files (`git add .`). If files are specified, only those specific files are staged before running the commit process._
+
+**Available Flags:**
+
+- `--model <provider>`: Overrides your default config to use a specific AI provider for this run (e.g., `--model local` to use Ollama/Gemma, or `--model cloud` for Gemini).
+- `--new-branch`: Automatically generates a relevant branch name from the AI analysis, creates the new branch, and checks it out.
+- `--push`: Automatically pushes the committed changes to your remote tracking repository. If an upstream branch is not found, it automatically creates one for you (`git push --set-upstream origin <branchName>`).
+- `--yes`: Skips the interactive prompts for both commit message generation and branch creation, automatically accepting the first AI-generated suggestion.
+- `--dry-run`: Simulates the process. It will generate the commit message and branch name, but will intentionally skip actually committing the files and creating the branch. Also unstages files if they were tracked during the command run.
+
+### `ai-ship config`
+
+Manages the global configuration for your `ai-ship` setup (such as API keys, default models, and user preferences).
+
+**Usage:**
+
+```bash
+ai-ship config <sub-command> [flags]
+```
+
+#### `config set`
+
+Sets a specific configuration key.
+
+**Usage:**
+
+```bash
+ai-ship config set <key> <value>
+```
+
+_Example: `ai-ship config set default-model local`_
+
+#### `config get`
+
+Retrieves the value of a specific configuration key.
+
+**Usage:**
+
+```bash
+ai-ship config get <key>
+```
+
+#### `config show`
+
+Displays your entire active configuration.
+
+**Available Flags:**
+
+- `--verbose`: Pretty-prints the config with color and readable formatting.
+- `--json`: Prints the config as raw JSON.
+
+#### Configuration Flags
+
+Other utility flags applicable when invoking `ai-ship config`:
+
+- `--add-key`: Interactively prompts you to add your AI Provider API key (e.g. Gemini API Key).
+- `--delete-key`: Instantly removes your stored API key.
+
+## Quick Examples
+
+**1. Fast auto-commit:**  
+Stages everything, generates a message, generates a branch and skips all interactive approvals.
+
+```bash
+ai-ship commit --new-branch --yes
+```
+
+**2. Preview what the AI thinks:**  
+See the AI-generated summary without altering the Git history.
+
+```bash
+ai-ship commit --dry-run
+```
+
+**3. Override the default model:**  
+Normally you use cloud, but today you want to test generating with your local Ollama setup.
+
+```bash
+ai-ship commit --model local
+```
+
+## Coming Soon
+
+### `ai-ship pr`
+
+Generate pull request titles and descriptions using commit history and diff analysis.