@pkpkpkddea/devdash 1.0.0

package/PUBLISHING.md

@@ -0,0 +1,133 @@
+# DevDash CLI - Publishing Guide
+
+## Package Created Successfully! 🎉
+
+Your CLI tool is ready at: `c:\Users\Bosco Leung\.git\DevTool-Suite\DevTool-Suite\devdash-cli`
+
+## Testing Locally
+
+1. **Navigate to the CLI directory**:
+   ```bash
+   cd "c:\Users\Bosco Leung\.git\DevTool-Suite\DevTool-Suite\devdash-cli"
+   ```
+
+2. **Install dependencies**:
+   ```bash
+   npm install
+   ```
+
+3. **Link the package globally** (for local testing):
+   ```bash
+   npm link
+   ```
+
+4. **Test the CLI**:
+   ```bash
+   # Navigate to any git repository
+   cd path/to/your/git/repo
+   
+   # Stage some changes
+   git add .
+   
+   # Generate commit message
+   devdash commit
+   ```
+
+5. **Test the config command**:
+   ```bash
+   devdash config --show
+   ```
+
+## Publishing to npm
+
+### Prerequisites
+
+1. **Create an npm account** (if you don't have one):
+   - Visit https://www.npmjs.com/signup
+   - Or run: `npm adduser`
+
+2. **Login to npm**:
+   ```bash
+   npm login
+   ```
+
+### Publishing Steps
+
+1. **Navigate to the CLI directory**:
+   ```bash
+   cd "c:\Users\Bosco Leung\.git\DevTool-Suite\DevTool-Suite\devdash-cli"
+   ```
+
+2. **Verify package contents** (dry run):
+   ```bash
+   npm publish --dry-run
+   ```
+   
+   This will show you what files will be included in the package.
+
+3. **Publish the package**:
+   ```bash
+   npm publish --access public
+   ```
+   
+   > Note: The `--access public` flag is required for scoped packages (@pkpkpkddea/devdash)
+
+4. **Verify publication**:
+   - Visit: https://www.npmjs.com/package/@pkpkpkddea/devdash
+   - Or run: `npm view @pkpkpkddea/devdash`
+
+## After Publishing
+
+### Install globally from npm:
+```bash
+npm install -g @pkpkpkddea/devdash
+```
+
+### Update your resume/portfolio:
+- ✅ Published npm package: `@pkpkpkddea/devdash`
+- ✅ Link: https://www.npmjs.com/package/@pkpkpkddea/devdash
+- ✅ Weekly downloads badge (add to README after publishing)
+
+## Updating the Package
+
+When you make changes:
+
+1. **Update version** in `package.json`:
+   ```bash
+   npm version patch  # for bug fixes (1.0.0 -> 1.0.1)
+   npm version minor  # for new features (1.0.0 -> 1.1.0)
+   npm version major  # for breaking changes (1.0.0 -> 2.0.0)
+   ```
+
+2. **Publish the update**:
+   ```bash
+   npm publish
+   ```
+
+## Troubleshooting
+
+### "Package name already exists"
+If someone already published `@pkpkpkddea/devdash`, you'll need to:
+1. Change the package name in `package.json`
+2. Update the README with the new name
+3. Try publishing again
+
+### "You must be logged in"
+Run `npm login` and enter your npm credentials.
+
+### "You do not have permission to publish"
+Make sure you're logged in with the correct account that owns the `@pkpkpkddea` scope.
+
+## Files Created
+
+- ✅ `package.json` - Package configuration
+- ✅ `bin/cli.js` - CLI implementation
+- ✅ `README.md` - User documentation
+- ✅ `.npmignore` - Files to exclude from npm package
+
+## Next Steps
+
+1. Test the CLI locally using `npm link`
+2. Verify everything works as expected
+3. Publish to npm using `npm publish --access public`
+4. Share your package with the world! 🚀

package/README.md

@@ -0,0 +1,148 @@
+# DevDash CLI
+
+> AI-powered commit message generator for your git workflow
+
+[![npm version](https://img.shields.io/npm/v/@pkpkpkddea/devdash.svg)](https://www.npmjs.com/package/@pkpkpkddea/devdash)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Features
+
+- 🤖 Generate descriptive commit messages using Google's Gemini AI
+- 📝 Analyzes your staged git changes automatically
+- ⚡ Simple CLI interface
+- 🔐 Secure API key storage in your home directory
+- 🎨 Beautiful, formatted commit messages
+
+## Installation
+
+```bash
+npm install -g @pkpkpkddea/devdash
+```
+
+## Quick Start
+
+1. **Stage your changes**:
+   ```bash
+   git add .
+   ```
+
+2. **Generate commit message**:
+   ```bash
+   devdash commit
+   ```
+
+3. **On first run**, you'll be prompted to enter your Google Gemini API key:
+   ```
+   🔑 Google Gemini API Key not found.
+   Get your free API key at: https://aistudio.google.com/app/apikey
+   
+   Enter your Google Gemini API Key: 
+   ```
+
+4. **Review the generated message** and use it:
+   ```bash
+   git commit -m "Your generated message"
+   ```
+
+## Commands
+
+### `devdash commit`
+
+Generate a commit message from your staged changes.
+
+```bash
+devdash commit
+```
+
+### `devdash config`
+
+Manage your DevDash configuration.
+
+**Set API key**:
+```bash
+devdash config --set-key YOUR_API_KEY
+```
+
+**Set AI model**:
+```bash
+devdash config --set-model gemini-2.5-pro
+```
+
+**Show current configuration**:
+```bash
+devdash config --show
+```
+
+## Getting Your API Key
+
+1. Visit [Google AI Studio](https://aistudio.google.com/app/apikey)
+2. Sign in with your Google account
+3. Click "Create API key"
+4. Copy the generated key
+5. Run `devdash commit` and paste the key when prompted
+
+The API key is **free** for typical personal usage.
+
+## Configuration
+
+Your configuration is stored in `~/.devdash/config.json`:
+
+```json
+{
+  "apiKey": "your-api-key",
+  "model": "gemini-2.0-flash"
+}
+```
+
+## Available Models
+
+- `gemini-2.0-flash` (default, recommended)
+- `gemini-2.5-flash`
+- `gemini-2.5-pro`
+- `gemini-2.0-flash-lite`
+- `gemini-flash-latest`
+- `gemini-pro-latest`
+
+## Example Output
+
+```bash
+$ devdash commit
+
+🤖 Generating commit message...
+
+📝 Suggested commit message:
+
+──────────────────────────────────────────────────
+Add user authentication and update API endpoints
+
+- Implemented JWT-based authentication system
+- Updated user login endpoint to return tokens
+- Added middleware for protected routes
+- Refactored error handling in auth module
+──────────────────────────────────────────────────
+
+To use this message, run:
+git commit -m "Add user authentication and update API endpoints"
+```
+
+## Requirements
+
+- Node.js >= 18.0.0
+- Git installed and accessible in PATH
+- Google Gemini API key
+
+## License
+
+MIT
+
+## Author
+
+pkpkpkddea
+
+## Contributing
+
+Issues and pull requests are welcome!
+
+## Repository
+
+[https://github.com/pkpkpkddea/DevTool-Suite](https://github.com/pkpkpkddea/DevTool-Suite)

package/bin/cli.js

@@ -0,0 +1,192 @@
+#!/usr/bin/env node
+
+import { Command } from 'commander';
+import { execSync } from 'child_process';
+import { createGoogleGenerativeAI } from '@ai-sdk/google';
+import { generateText } from 'ai';
+import * as fs from 'fs';
+import * as path from 'path';
+import * as os from 'os';
+import * as readline from 'readline';
+
+const CONFIG_DIR = path.join(os.homedir(), '.devdash');
+const CONFIG_FILE = path.join(CONFIG_DIR, 'config.json');
+
+// Ensure config directory exists
+function ensureConfigDir() {
+    if (!fs.existsSync(CONFIG_DIR)) {
+        fs.mkdirSync(CONFIG_DIR, { recursive: true });
+    }
+}
+
+// Read config
+function readConfig() {
+    ensureConfigDir();
+    if (fs.existsSync(CONFIG_FILE)) {
+        const data = fs.readFileSync(CONFIG_FILE, 'utf-8');
+        return JSON.parse(data);
+    }
+    return {};
+}
+
+// Write config
+function writeConfig(config) {
+    ensureConfigDir();
+    fs.writeFileSync(CONFIG_FILE, JSON.stringify(config, null, 2));
+}
+
+// Prompt user for input
+function promptUser(question) {
+    return new Promise((resolve) => {
+        const rl = readline.createInterface({
+            input: process.stdin,
+            output: process.stdout
+        });
+        rl.question(question, (answer) => {
+            rl.close();
+            resolve(answer);
+        });
+    });
+}
+
+// Get API key (prompt if not exists)
+async function getApiKey() {
+    const config = readConfig();
+
+    if (config.apiKey) {
+        return config.apiKey;
+    }
+
+    console.log('🔑 Google Gemini API Key not found.');
+    console.log('Get your free API key at: https://aistudio.google.com/app/apikey\n');
+
+    const apiKey = await promptUser('Enter your Google Gemini API Key: ');
+
+    if (!apiKey || !apiKey.trim()) {
+        console.error('❌ API key is required.');
+        process.exit(1);
+    }
+
+    config.apiKey = apiKey.trim();
+    writeConfig(config);
+    console.log('✅ API key saved to ~/.devdash/config.json\n');
+
+    return config.apiKey;
+}
+
+// Get model (use default or from config)
+function getModel() {
+    const config = readConfig();
+    return config.model || 'gemini-2.0-flash';
+}
+
+// Set model
+function setModel(model) {
+    const config = readConfig();
+    config.model = model;
+    writeConfig(config);
+    console.log(`✅ Model set to: ${model}`);
+}
+
+// Generate commit message
+async function generateCommitMessage() {
+    try {
+        // Check if git is available
+        try {
+            execSync('git --version', { stdio: 'ignore' });
+        } catch (error) {
+            console.error('❌ Git is not installed or not in PATH.');
+            process.exit(1);
+        }
+
+        // Get staged changes
+        let diff;
+        try {
+            diff = execSync('git diff --staged', { encoding: 'utf-8' });
+        } catch (error) {
+            console.error('❌ Failed to get git diff. Are you in a git repository?');
+            process.exit(1);
+        }
+
+        if (!diff || diff.trim().length === 0) {
+            console.log('⚠️  No staged changes found. Stage your changes with "git add" first.');
+            process.exit(0);
+        }
+
+        console.log('🤖 Generating commit message...\n');
+
+        // Get API key
+        const apiKey = await getApiKey();
+        const model = getModel();
+
+        // Call Gemini API
+        const google = createGoogleGenerativeAI({
+            apiKey: apiKey,
+        });
+
+        const { text } = await generateText({
+            model: google(model),
+            system: `You are a senior DevOps engineer. Summarize this code diff into a descriptive commit message. Format it with a concise subject line (imperative mood), followed by a blank line, and then a bulleted list of changes explaining "what" and "why". Do not use conventional commit prefixes like "feat:" or "chore:".
+
+Example format:
+Remove old_file.txt and update new_file.txt
+
+- Deleted old_file.txt as it contained outdated information.
+- Added additional context to new_file.txt for clarity on project updates.
+
+Only return the commit message, no other text.`,
+            prompt: diff,
+        });
+
+        console.log('📝 Suggested commit message:\n');
+        console.log('─'.repeat(50));
+        console.log(text);
+        console.log('─'.repeat(50));
+        console.log('\nTo use this message, run:');
+        console.log(`git commit -m "${text.split('\n')[0]}"`);
+
+    } catch (error) {
+        console.error('❌ Error:', error.message);
+        process.exit(1);
+    }
+}
+
+// CLI setup
+const program = new Command();
+
+program
+    .name('devdash')
+    .description('CLI tool for generating commit messages using AI')
+    .version('1.0.0');
+
+program
+    .command('commit')
+    .description('Generate a commit message from staged changes')
+    .action(generateCommitMessage);
+
+program
+    .command('config')
+    .description('Configure DevDash settings')
+    .option('--set-key <key>', 'Set Google Gemini API key')
+    .option('--set-model <model>', 'Set AI model (e.g., gemini-2.0-flash)')
+    .option('--show', 'Show current configuration')
+    .action((options) => {
+        if (options.setKey) {
+            const config = readConfig();
+            config.apiKey = options.setKey;
+            writeConfig(config);
+            console.log('✅ API key updated.');
+        } else if (options.setModel) {
+            setModel(options.setModel);
+        } else if (options.show) {
+            const config = readConfig();
+            console.log('Current configuration:');
+            console.log('  API Key:', config.apiKey ? '***' + config.apiKey.slice(-4) : 'Not set');
+            console.log('  Model:', config.model || 'gemini-2.0-flash (default)');
+            console.log('  Config file:', CONFIG_FILE);
+        } else {
+            console.log('Use --set-key, --set-model, or --show');
+        }
+    });
+
+program.parse(process.argv);

package/package.json

@@ -0,0 +1,34 @@
+{
+    "name": "@pkpkpkddea/devdash",
+    "version": "1.0.0",
+    "type": "module",
+    "description": "CLI tool for generating commit messages using AI",
+    "main": "bin/cli.js",
+    "bin": {
+        "devdash": "./bin/cli.js"
+    },
+    "scripts": {
+        "test": "echo \"Error: no test specified\" && exit 1"
+    },
+    "keywords": [
+        "git",
+        "commit",
+        "ai",
+        "cli",
+        "devtools"
+    ],
+    "author": "pkpkpkddea",
+    "license": "MIT",
+    "dependencies": {
+        "@ai-sdk/google": "^3.0.10",
+        "ai": "^6.0.38",
+        "commander": "^12.1.0"
+    },
+    "engines": {
+        "node": ">=18.0.0"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/pkpkpkddea/DevTool-Suite.git"
+    }
+}