xoegit 1.1.1 → 1.1.3

package/README.md

@@ -6,6 +6,8 @@
 [![npm](https://img.shields.io/npm/v/xoegit?color=cb3837&logo=npm&logoColor=white)](https://www.npmjs.com/package/xoegit)
 [![License](https://img.shields.io/badge/License-MIT-green)](https://github.com/ujangdoubleday/xoegit/blob/main/LICENSE.md)
 
+<img src="docs/xoegit-banner.png" alt="xoegit banner" width="100%">
+
 **xoegit** is an AI-powered CLI tool that generates concise, semantic, and atomic git commit messages and PR descriptions. It analyzes your `git diff`, `git status`, and `git log` to provide context-aware suggestions powered by Google's Gemini models.
 
 > **Philosophy:** "Craft, Don't Code" — `xoegit` suggests commands; YOU execute them. You stay in control.
@@ -18,11 +20,17 @@
 - **Semantic Commits** — Strictly follows [Conventional Commits](https://www.conventionalcommits.org/)
 - **PR Ready** — Generates ready-to-use PR title and description
 
+## How It Works
+
+> **Important:** `xoegit` **never** stages your files, commits your changes, or modifies your repository in any way. It only analyzes your changes and provides recommendations that you can review and execute yourself.
+
+You remain in full control of your git workflow.
+
 ## Installation
 
 ### Prerequisites
 
-- **Node.js**: Version 20.19.5 or higher
+- **Node.js**: Minimum version 20.19.5 or higher
 - **Git**: Must be installed and available in your PATH
 - **API Key**: A Google Gemini API key ([get one here](https://aistudio.google.com/))
 
@@ -44,10 +52,12 @@ make
 
 Simply run `xoegit` for the first time. It will prompt you for your API Key securely and save it locally.
 
-> **Security Note:** Your API key is stored locally on your device only. We do not collect, store, or have access to your API key.
+> **Security Note:** Your API key is stored locally on your device only. We do not collect, store, or have access to your API key. See [Security Policy](SECURITY.md) for details.
 
 ## Usage
 
+Then, from whatever project you're working on, just run:
+
 ```bash
 xoegit
 ```
@@ -60,21 +70,40 @@ xoegit
 | ---------------------- | --------------------------------------------- |
 | `-k, --api-key <key>`  | Use specific API key for this session         |
 | `-c, --context <text>` | Provide context for more accurate suggestions |
+| `-s, --set-key <key>`  | Save API key to config
+| `-d, --delete-key`     | Delete saved API key from config              |
 | `-V, --version`        | Show version                                  |
 | `-h, --help`           | Show help                                     |
 
 ### Examples
 
+**Basic usage:**
+
 ```bash
-# Basic usage
 xoegit
+```
 
-# With context for better commit type detection
+**With context for better commit type detection:**
+
+```bash
 xoegit --context "refactoring folder structure"
 xoegit -c "fixing authentication bug"
 xoegit -c "adding new payment feature"
 ```
 
+**Use API key for this session only (not saved):**
+
+```bash
+xoegit --api-key "YOUR_GEMINI_API_KEY"
+```
+
+**Manage API key:**
+
+```bash
+xoegit --set-key "YOUR_GEMINI_API_KEY"
+xoegit --delete-key
+```
+
 ### Sample Output
 
 ```
@@ -96,18 +125,6 @@ pr description: feat(auth): implement secure login
 - refactor(utils): improve error logging
 ```
 
-## Smart Model Fallback
-
-xoegit uses multiple Gemini models with automatic fallback:
-
-| Model                   | Priority      |
-| ----------------------- | ------------- |
-| `gemini-2.5-flash-lite` | 1st (default) |
-| `gemini-2.5-flash`      | 2nd           |
-| `gemini-3-flash`        | 3rd           |
-
-When one model hits its rate limit, xoegit automatically tries the next one.
-
 ## Troubleshooting
 
 ### "Current directory is not a git repository"
@@ -129,9 +146,12 @@ npm run build
 
 # Run tests
 npm test
+```
 
-# Watch mode for tests
-npm run test:watch
+**or** use `make`:
+
+```bash
+make
 ```
 
 ## Project Structure

package/dist/cli/analyze.js

@@ -16,6 +16,22 @@ export async function analyzeAction() {
         const options = program.opts();
         let apiKey = options.apiKey;
         const configService = new ConfigService();
+        // Handle --set-key flag (save and exit)
+        if (options.setKey) {
+            if (!isValidApiKey(options.setKey)) {
+                showError('Invalid API Key', 'Please provide a valid API key.');
+                process.exit(1);
+            }
+            await configService.saveApiKey(options.setKey);
+            showSuccess('API Key saved successfully!');
+            return;
+        }
+        // Handle --delete-key flag (delete and exit)
+        if (options.deleteKey) {
+            await configService.deleteApiKey();
+            showSuccess('API Key deleted successfully!');
+            return;
+        }
         if (!apiKey) {
             apiKey = await configService.getApiKey();
         }

package/dist/cli/program.js

@@ -1,8 +1,11 @@
 import { Command } from 'commander';
+import { VERSION } from '../config/version.js';
 export const program = new Command();
 program
     .name('xoegit')
     .description('AI-powered git commit generator')
-    .version('0.1.0')
+    .version(VERSION)
     .option('-k, --api-key <key>', 'Gemini API Key')
-    .option('-c, --context <context>', 'Context for the changes (e.g., "refactoring folder structure")');
+    .option('-c, --context <context>', 'Context for the changes (e.g., "refactoring folder structure")')
+    .option('-s, --set-key <key>', 'Save Gemini API Key to config (overwrites existing)')
+    .option('-d, --delete-key', 'Delete saved API Key from config');

package/dist/config/service.js

@@ -44,4 +44,24 @@ export class ConfigService {
             throw new Error(`Failed to save configuration: ${error.message}`);
         }
     }
+    async deleteApiKey() {
+        try {
+            const configStr = await fs.readFile(this.configPath, 'utf-8');
+            const config = JSON.parse(configStr);
+            delete config.XOEGIT_GEMINI_API_KEY;
+            if (Object.keys(config).length === 0) {
+                // Delete the file if no other config remains
+                await fs.unlink(this.configPath);
+            }
+            else {
+                await fs.writeFile(this.configPath, JSON.stringify(config, null, 2), { mode: 0o600 });
+            }
+        }
+        catch (error) {
+            // Ignore if file doesn't exist
+            if (error.code !== 'ENOENT') {
+                throw new Error(`Failed to delete API key: ${error.message}`);
+            }
+        }
+    }
 }

package/dist/config/version.js

@@ -0,0 +1,4 @@
+import { createRequire } from 'module';
+const require = createRequire(import.meta.url);
+const pkg = require('../../package.json');
+export const VERSION = pkg.version;

package/dist/utils/ui.js

@@ -16,7 +16,16 @@ const brand = {
  * App banner
  */
 export function showBanner() {
-    console.log(`\n${brand.primary('⚡')} ${brand.secondary.bold('xoegit')} ${brand.muted('— AI-powered commit generator')}\n`);
+    const banner = `
+██╗      ██╗  ██╗ ██████╗ ███████╗ ██████╗ ██╗████████╗
+╚██╗     ╚██╗██╔╝██╔═══██╗██╔════╝██╔════╝ ██║╚══██╔══╝
+ ╚██╗     ╚███╔╝ ██║   ██║█████╗  ██║  ███╗██║   ██║   
+ ██╔╝     ██╔██╗ ██║   ██║██╔══╝  ██║   ██║██║   ██║   
+██╔╝     ██╔╝ ██╗╚██████╔╝███████╗╚██████╔╝██║   ██║   
+╚═╝      ╚═╝  ╚═╝ ╚═════╝ ╚══════╝ ╚═════╝ ╚═╝   ╚═╝   
+`;
+    console.log(banner);
+    console.log(brand.muted('by https://github.com/ujangdoubleday\n'));
 }
 /**
  * Display the AI suggestion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xoegit",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "AI-powered CLI tool for generating semantic git commit messages and PR descriptions",
   "license": "MIT",
   "author": "ujangdoubleday",