@flowdevcli/flowdev 1.0.9 → 1.1.0

package/README.md

@@ -1,157 +1,359 @@
-FLOWDEV
-=======
-The intelligent CLI for modern workflow automation.
+# FLOWDEV
 
-FlowDev is a privacy-first, offline-capable CLI tool designed to accelerate developer workflows. From scaffolding Docker environments to generating project structures using local or cloud AI, FlowDev keeps you in the flow without leaving your terminal.
+**FlowDev — The Intelligent CLI for Modern Workflow Automation**
 
-> "The developer tool for the next generation."
+FlowDev is a privacy-first, hybrid AI-powered Command Line Interface designed to accelerate and automate modern developer workflows. From infrastructure scaffolding to AI-assisted audits and documentation generation, FlowDev keeps developers productive without leaving the terminal.
 
-[![npm version](https://img.shields.io/npm/v/flowdev.svg?style=flat-square)](https://www.npmjs.com/package/flowdev)
-[![install size](https://img.shields.io/badge/install%20size-unknown-blue?style=flat-square)](https://packagephobia.com/result?p=flowdev)
-[![downloads](https://img.shields.io/npm/dm/flowdev.svg?style=flat-square)](https://www.npmjs.com/package/flowdev)
+> “Automation without context switching.”
 
-Install
-=======
+Published on npm. Designed for professional environments and production-grade workflows.
 
-Global Installation (Recommended)
----------------------------------
-To use FlowDev commands anywhere on your system:
+---
+
+Replace the path above with your official SVG logo. SVG format is strongly recommended for clarity and scalability.
+
+---
+
+## Badges
+
+[![npm version](https://img.shields.io/npm/v/flowdev.svg?style=flat-square)](https://www.npmjs.com/package/flowdev)  
+[![weekly downloads](https://img.shields.io/npm/dw/flowdev.svg?style=flat-square)](https://www.npmjs.com/package/flowdev)  
+[![license](https://img.shields.io/badge/license-MIT-green?style=flat-square)](./LICENSE)  
+[![node version](https://img.shields.io/badge/node-%3E%3D18-blue?style=flat-square)](https://nodejs.org)
+
+---
+
+## Table of Contents
+
+- Overview
+- Installation
+- Core Commands
+- AI Capabilities
+- DevOps Utilities
+- Project Scaffolding
+- Feature Comparison
+- Requirements
+- AI Configuration (Local & Cloud)
+- Versioning & Known Issues
+- Maintainer Workflow
+- Contributing
+- License
+
+---
+
+## Overview
+
+FlowDev provides:
+
+• AI-assisted development  
+• Automated Docker and Kubernetes configuration  
+• Intelligent project analysis  
+• AI-generated documentation  
+• Hybrid local/cloud processing architecture  
+• CI-ready deterministic outputs  
+
+It is built for developers and teams who value speed, clarity, reproducibility, and terminal-native workflows.
+
+FlowDev integrates with local AI runtimes such as Ollama and optionally supports cloud-based reasoning providers. Cloud usage is strictly opt-in.
+
+---
+
+## Installation
+
+### Global Installation (Recommended)
 
 ```bash
 npm install -g flowdev
+```
 
-Local Installation
+### Local Installation (Per Project)
 
-If you prefer to use it per project:
-Bash
+```bash
+npm install --save-dev flowdev
+```
 
-npm install flowdev --save-dev
+### Verify Installation
 
-Usage
+```bash
+flowdev --version
+```
 
-Once installed, FlowDev exposes the flowdev binary.
+---
 
-    Check your installation:
+## Core Commands
 
-Bash
-flowdev --version
+### Display Version
 
-    *Configure your environment (API keys & Models):
-Bash
-flowdev config
+```bash
+flowdev version
+```
+
+---
 
+### Project Tree Visualization
+
+```bash
+flowdev tree
+```
 
-    *Analyze your current project:
-Bash
+---
+
+### Project Statistics Analysis
+
+```bash
 flowdev stats
+```
 
-    *Generate a Docker environment:
-Bash
-flowdev dockerize
+---
+
+### Pattern Search (Recursive, Developer-Optimized)
+
+```bash
+flowdev find "TODO" --ext js,ts
+```
+
+---
+
+## AI Capabilities
 
-Features
-AI & Automation (Hybrid Engine)
+### Ask AI a Technical Question
 
-FlowDev integrates with Ollama for offline capabilities and supports DeepSeek for high-performance cloud reasoning.
+```bash
+flowdev ask "How can I optimize a React useEffect hook?"
+```
+
+---
 
-1. Smart Assistant
-Ask questions about code or architecture using local or cloud models.
-Bash
+### Explain a Source File
+
+```bash
+flowdev explain src/app.js
+```
 
-flowdev ask "How do I optimize a React useEffect hook?"
+---
 
-2. Intelligent Audit
-Audit your code for bugs, security, and performance using AI.
-Bash
+### Audit Code (Security, Performance, Logic)
 
+```bash
 flowdev audit
+```
+
+---
+
+### Generate Unit Tests for a File
 
-3. Automatic Documentation
-Generate a professional README.md for your project instantly.
-Bash
+```bash
+flowdev test src/app.js
+```
+
+---
 
+### Generate README Automatically
+
+```bash
 flowdev readme
+```
+
+---
+
+### AI-Powered Commit Message
+
+```bash
+flowdev commit
+```
+
+---
 
-DevOps & Infrastructure
+## DevOps Utilities
 
-1. Dockerize
-Instantly generate production-ready Dockerfile and docker-compose.yml files.
-Bash
+### Generate Docker Configuration
 
+```bash
 flowdev dockerize
+```
+
+Automatically creates:
 
-2. Kubernetes (Kube)
-Generate Kubernetes deployment and service manifests for your application.
-Bash
+• Production-ready Dockerfile  
+• docker-compose.yml  
+• Multi-stage builds  
+• Non-root security practices  
 
+---
+
+### Generate Kubernetes Manifests
+
+```bash
 flowdev kube
+```
 
-Utilities
+Creates deployment and service configuration files.
 
-1. Generate
-Generate a complete project (React, Django, Vue, Angular, Express) with Git and dependencies automatically configured.
-Bash
+---
 
+### Generate Environment Template
+
+```bash
+flowdev env
+```
+
+Scans your codebase and generates a `.env.example` file.
+
+---
+
+## Project Scaffolding
+
+### Generate a Full Project
+
+```bash
 flowdev generate
+```
 
-2. Find (Pattern Search)
-A recursive search tool optimized for developers. Ignores node_modules and binaries.
-Bash
+Supports scaffolding for:
 
-flowdev find "TODO" --ext js,ts
+• React  
+• Django  
+• Vue  
+• Angular  
+• Express  
 
-3. Stats
-Get an instant breakdown of your project's size, file count, and language distribution.
-Bash
+Includes Git initialization and dependency installation.
 
-flowdev stats
+---
 
-Requirements
-Node.js
+## Feature Comparison
 
-FlowDev requires Node.js v18+.
-Local AI (Optional)
+| Capability                          | FlowDev | Custom Scripts | Generic CLI Tools |
+|-------------------------------------|:-------:|:--------------:|:-----------------:|
+| Terminal-first design               | Yes     | Partial        | Partial           |
+| Local AI (offline support)          | Yes     | No             | No                |
+| AI code auditing                    | Yes     | No             | Limited           |
+| Docker + Kubernetes generation      | Yes     | Partial        | Varies            |
+| Automatic README generation         | Yes     | No             | Limited           |
+| Environment template generation     | Yes     | No             | No                |
+| CI-compatible structured output     | Yes     | Varies         | Varies            |
 
-To use local AI features, you must have Ollama running locally.
+---
 
-    Install Ollama: ollama.com
+## Requirements
 
-    Start the service: ollama serve
+• Node.js v18 or higher  
+• Optional: Local AI via Ollama  
+• Optional: Cloud AI API key  
 
-    FlowDev handles the rest.
+---
 
-Cloud AI (Optional)
+## AI Configuration
 
-To use Cloud features (DeepSeek), configure your API key via flowdev config.
-Documentation
-flowdev generate
+### Local AI (Offline Mode)
 
-Provisions full-stack templates. Includes a fail-safe execution wrapper that generates a flowdev-debug.log if an installation fails.
-flowdev audit
+To enable local AI features:
 
-Uses AI to scan for security vulnerabilities and logic flaws. Perfect for pre-commit checks.
-flowdev dockerize
+1. Install Ollama
+2. Start the service:
 
-Generates optimized configurations using multi-stage builds and non-root security practices.
-flowdev env
+```bash
+ollama serve
+```
+
+FlowDev will automatically detect and use the local runtime.
+
+---
+
+### Cloud AI
+
+To enable cloud-based reasoning:
+
+```bash
+flowdev config
+```
+
+Add your API key and select your preferred model.
+
+Cloud usage is strictly opt-in and fully configurable.
+
+---
+
+## Versioning & Known Issues
+
+### Current Stable Version
+
+Use version:
+
+```bash
+>= 1.0.11
+```
+
+### Important Notice
+
+Versions **1.0.5 through 1.0.9** contained critical regressions and should not be used in production environments.
+
+If you are using one of these versions, upgrade immediately:
+
+```bash
+npm install -g flowdev@latest
+```
+
+---
+
+## Maintainer Workflow
+
+### Publishing a New Version
+
+After modifying code or documentation:
+
+```bash
+npm version patch
+npm publish
+```
+
+### Deprecating Faulty Versions
+
+To deprecate a specific version:
+
+```bash
+npm deprecate flowdev@1.0.7 "Critical bug — upgrade to >= 1.0.11"
+```
+
+To deprecate multiple versions:
+
+```bash
+for v in 1.0.5 1.0.6 1.0.7 1.0.8 1.0.9; do
+  npm deprecate flowdev@$v "Critical bugs — upgrade to >= 1.0.11"
+done
+```
+
+To verify deprecation:
+
+```bash
+npm view flowdev@1.0.5 deprecated
+```
+
+---
+
+## Contributing
+
+1. Fork the repository  
+2. Create a feature branch  
+3. Submit a Pull Request with clear technical description  
+4. Follow semantic versioning principles  
 
-Scans your project code and generates a .env.example file based on your environment variable usage.
-FAQ
-Does FlowDev send my code to the cloud?
+Major architectural changes should begin with a proposal issue before implementation.
 
-By default, No. Local AI processing happens on your machine via Ollama. Cloud processing is only used if you explicitly configure it and choose a cloud model.
-Do I need an API Key?
+---
 
-No for local use. Yes if you wish to use cloud models like DeepSeek.
-Why "flowdev"?
+## Philosophy
 
-Because switching contexts breaks your flow. FlowDev keeps you in the terminal, automating the boring stuff so you can focus on the code.
-Changelog
+FlowDev exists to reduce friction in modern development.
 
-See CHANGELOG.md for details on recent updates.
-License
+Automation should enhance engineering judgment, not replace it.  
+Tooling should remain transparent, reproducible, and privacy-aware.  
+The terminal remains the most powerful development interface.
 
-[MIT](https://www.google.com/search?q=LICENSE)
+---
 
+## License
 
+MIT License
 
+© 2026 FlowDev Technologies

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowdevcli/flowdev",
-  "version": "1.0.9",
+  "version": "1.1.0",
   "description": "AI-powered CLI tool",
   "type": "module",
   "bin": {

package/src/commands/git/commit.js

@@ -0,0 +1,109 @@
+import { execSync } from 'node:child_process';
+import chalk from 'chalk';
+import ora from 'ora';
+import inquirer from 'inquirer';
+import { logger } from '../../utils/logger.js';
+import { selectAIModel, ensureEngineReady, getAIResponse } from '../../utils/engine-check.js';
+
+export async function commitCommand() {
+  try {
+    try {
+      execSync('git rev-parse --is-inside-work-tree', { stdio: 'ignore' });
+    } catch (e) {
+      logger.error('Not a git repository. Please initialize git first.');
+      return;
+    }
+
+    const diff = execSync('git diff --cached').toString();
+
+    if (!diff) {
+      console.log(chalk.yellow('\nNo changes staged. Please use "git add" before committing.'));
+      return;
+    }
+
+    const provider = await selectAIModel();
+    const spinner = ora(chalk.cyan('Analyzing staged changes...')).start();
+
+    await ensureEngineReady(spinner, provider);
+
+    const prompt = `Analyze this git diff and write a concise "Conventional Commit" message (feat, fix, docs, style, refactor, chore). 
+    Return ONLY the message, no markdown, no quotes, no explanations.
+    
+    Diff:
+    ${diff.substring(0, 8000)}`;
+
+    const responseStream = await getAIResponse(provider, prompt);
+    
+    let suggestedMessage = "";
+    for await (const part of responseStream) {
+      suggestedMessage += part.message.content;
+    }
+
+    spinner.stop();
+    suggestedMessage = suggestedMessage.trim();
+
+    console.log(chalk.gray('\nProposed Commit Message:'));
+    console.log(chalk.bold.green(`"${suggestedMessage}"\n`));
+
+    const { action } = await inquirer.prompt([
+      {
+        type: 'list',
+        name: 'action',
+        message: 'Select an action for this commit:',
+        choices: [
+          { name: 'Commit this message', value: 'commit' },
+          { name: 'Edit message manually', value: 'edit' },
+          { name: 'Cancel operation', value: 'cancel' }
+        ]
+      }
+    ]);
+
+    if (action === 'cancel') {
+      console.log(chalk.gray('Commit operation cancelled.'));
+      return;
+    }
+
+    let finalMessage = suggestedMessage;
+    if (action === 'edit') {
+      const { edited } = await inquirer.prompt([{
+        type: 'input',
+        name: 'edited',
+        message: 'Enter your commit message:',
+        default: suggestedMessage
+      }]);
+      finalMessage = edited;
+    }
+
+    const safeMessage = finalMessage.replace(/"/g, '\\"');
+    execSync(`git commit -m "${safeMessage}"`, { stdio: 'ignore' });
+    
+    console.log(chalk.green('Changes committed successfully.'));
+
+    const { pushAction } = await inquirer.prompt([
+      {
+        type: 'confirm',
+        name: 'pushAction',
+        message: 'Do you want to push these changes to the remote repository?',
+        default: false
+      }
+    ]);
+
+    if (pushAction) {
+      const pushSpinner = ora(chalk.cyan('Pushing to remote...')).start();
+      try {
+
+        execSync('git push', { stdio: 'pipe' });
+        pushSpinner.succeed(chalk.green('Changes pushed to remote successfully.'));
+      } catch (pushErr) {
+        pushSpinner.fail(chalk.red('Push operation failed.'));
+        const stderr = pushErr.stderr ? pushErr.stderr.toString() : pushErr.message;
+        console.log(chalk.yellow(`\nGit output:\n${stderr.trim()}`));
+      }
+    }
+
+  } catch (error) {
+    const spinner = ora();
+    if (spinner.isSpinning) spinner.stop();
+    logger.error(`Commit error: ${error.message}`);
+  }
+}

package/src/core/cli.js

@@ -34,7 +34,9 @@ import { generateCommand } from '../commands/scaffold/generate.js';
 import { auditCommand } from '../commands/ai/audit.js';
 import { testCommand } from '../commands/ai/test.js';
 import { updateCommand } from '../commands/system/update.js';
+import { readmeCommand } from '../commands/ai/readme.js';
 import { configCommand } from '../commands/config.js'
+import { commitCommand } from '../commands/git/commit.js';
 
 
 const require = createRequire(import.meta.url);
@@ -137,6 +139,11 @@ export function setupCLI() {
   .description('Automatically generate a README.md for the project')
   .action(readmeCommand);
 
+  program
+  .command('commit')
+  .description('Generate an AI-powered commit message based on staged changes')
+  .action(commitCommand);
+
  program
   .command('config')
   .description('Configure AI models (API keys, settings)')