cmdvault 1.0.0

package/README.md

@@ -0,0 +1,433 @@
+# CmdVault
+
+A smart terminal assistant that remembers, stores, and executes shell commands using user-defined keys.
+
+## Features
+
+- 🚀 Execute commands directly through CmdVault
+- 💾 Store frequently used commands with memorable keys
+- 🔄 Retrieve and execute stored commands instantly
+- 🤖 **AI-powered command generation** from natural language
+- 📝 Edit stored commands with your preferred editor
+- 📋 List all saved commands in a beautiful table
+- 🎨 Colored output for better readability
+- 🔒 Confirmation prompts for destructive operations
+- 🌍 Cross-platform support (Windows, Mac, Linux)
+- ⚡ Live command output streaming
+- 🔌 Multiple AI provider support (OpenAI, Anthropic, Google Gemini, Groq, OpenRouter)
+
+## Installation
+
+### Install Globally
+
+```bash
+npm install -g
+```
+
+Or from npm (once published):
+
+```bash
+npm install -g cmdvault
+```
+
+### Local Development
+
+```bash
+# Clone the repository
+cd smart-term
+
+# Install dependencies
+npm install
+
+# Link globally for testing
+npm link
+```
+
+## Usage
+
+### 1. Execute a Command Directly
+
+Run any shell command through CmdVault:
+
+```bash
+cm git status
+cm npm test
+cm ls -la
+```
+
+### 2. Save a Command
+
+Store a command with a memorable key:
+
+```bash
+cm s <key> <command>
+```
+
+**Examples:**
+
+```bash
+cm s gs git status
+cm s gp git pull origin main
+cm s dev npm run dev
+cm s build npm run build && npm run test
+```
+
+The command will execute immediately and be saved for future use.
+
+### 3. Retrieve and Execute a Stored Command
+
+Simply use the key to execute the stored command:
+
+```bash
+cm gs
+# Executes: git status
+
+cm gp
+# Executes: git pull origin main
+```
+
+### 4. Expand Command Without Executing
+
+Get the stored command printed to terminal without executing it:
+
+```bash
+cm c gs
+# Outputs: git status
+# Does NOT execute - you can copy/paste or edit it
+```
+
+This is useful when you want to:
+- See what a command does before running it
+- Edit the command before execution
+- Copy the command for use elsewhere
+
+**Pro Tip:** You can use command substitution to insert it into your terminal:
+
+```bash
+# Copy output and paste manually
+cm c gs
+
+# Or use in a script
+COMMAND=$(cm c gs)
+echo "About to run: $COMMAND"
+eval $COMMAND
+```
+
+### 5. AI Command Generation 🤖
+
+Generate shell commands from natural language using AI:
+
+```bash
+cm -g "list all pdf files in current directory"
+# AI generates: find . -maxdepth 1 -name "*.pdf"
+# Execute this command? (y/n):
+```
+
+**First time setup:**
+```bash
+cm config
+# Select AI provider (OpenAI, Anthropic, Gemini, Groq, OpenRouter)
+# Enter your API key
+# Start generating commands!
+```
+
+**More examples:**
+```bash
+cm -g "show git commits from last week"
+cm -g "find process using port 3000"
+cm -g "compress all log files"
+```
+
+### 6. List All Saved Commands
+
+View all your stored commands in a formatted table:
+
+```bash
+cm list
+```
+
+Output:
+```
+┌───────────────┬─────────────────────────────────────────────────────────────────┐
+│ Key           │ Command                                                         │
+├───────────────┼─────────────────────────────────────────────────────────────────┤
+│ dev           │ npm run dev                                                     │
+├───────────────┼─────────────────────────────────────────────────────────────────┤
+│ gp            │ git pull origin main                                            │
+├───────────────┼─────────────────────────────────────────────────────────────────┤
+│ gs            │ git status                                                      │
+└───────────────┴─────────────────────────────────────────────────────────────────┘
+
+Total: 3 command(s)
+```
+
+### 5. Edit a Stored Command
+
+Modify a stored command using your system editor:
+
+```bash
+cm e <key>
+```
+
+**Example:**
+
+```bash
+cm e gp
+```
+
+This opens your default editor (nano, vim, or notepad) to edit the command.
+
+**Set your preferred editor:**
+
+```bash
+export EDITOR=vim    # Linux/Mac
+set EDITOR=code      # Windows
+```
+
+### 8. Delete a Stored Command
+
+Remove a stored command:
+
+```bash
+cm d <key>
+```
+
+**Example:**
+
+```bash
+cm d gs
+# Prompts for confirmation before deleting
+```
+
+## Command Reference
+
+| Command | Description | Example |
+|---------|-------------|---------|
+| `cm <command>` | Execute a command directly | `cm git status` |
+| `cm s <key> <command>` | Save/store a command | `cm s gs git status` |
+| `cm <key>` | Execute a stored command | `cm gs` |
+| `cm c <key>` | Copy/expand command (no execution) | `cm c gs` |
+| `cm -g "<prompt>"` | Generate command using AI | `cm -g "list files"` |
+| `cm config` | Configure AI providers | `cm config` |
+| `cm list` | List all stored commands | `cm list` |
+| `cm e <key>` | Edit a stored command | `cm e gs` |
+| `cm d <key>` | Delete a stored command | `cm d gs` |
+| `cm --help` | Show help information | `cm --help` |
+| `cm --version` | Show version | `cm --version` |
+
+## Storage Location
+
+Commands are stored in a JSON file at:
+
+- **Linux/Mac:** `~/.cmvault/commands.json`
+- **Windows:** `C:\Users\<username>\.cmvault\commands.json`
+
+Example `commands.json`:
+```json
+{
+  "gs": "git status",
+  "gp": "git pull origin main",
+  "dev": "npm run dev"
+}
+```
+
+## Examples
+
+### Git Workflow
+
+```bash
+# Store common git commands
+cm s gs git status
+cm s ga git add .
+cm s gc git commit -m
+cm s gp git push origin main
+cm s gl git log --oneline -10
+
+# Use them
+cm gs
+cm ga
+cm gc "feat: add new feature"
+cm gp
+```
+
+### Development Workflow
+
+```bash
+# Store project commands
+cm s dev npm run dev
+cm s build npm run build
+cm s test npm test
+cm s lint npm run lint
+cm s deploy npm run build && npm run deploy
+
+# Quick execution
+cm dev
+cm test
+cm build
+```
+
+### System Administration
+
+```bash
+# Store system commands
+cm s ports lsof -i -P -n | grep LISTEN
+cm s mem free -h
+cm s disk df -h
+cm s procs ps aux | grep node
+
+# Execute instantly
+cm ports
+cm mem
+```
+
+## Features in Detail
+
+### Overwrite Protection
+
+When storing a command with an existing key, CmdVault asks for confirmation:
+
+```bash
+cm s gs git status
+# Key "gs" already exists. Overwrite? (y/n):
+```
+
+### ✅ Failed Command Handling
+
+If a command fails during recording, CmdVault asks if you still want to save it:
+
+```bash
+cm s test npm test
+# Command failed: Command exited with code 1
+# Save command anyway? (y/n):
+```
+
+### ✅ Live Output Streaming
+
+Commands stream their output in real-time, not buffered:
+
+```bash
+cm dev
+# Output appears immediately as the command runs
+```
+
+### ✅ Execution Confirmation
+
+After executing a stored command, CmdVault shows what was executed:
+
+```bash
+cm gp
+[CM] Executing stored command: git pull origin main
+# ... command output ...
+[CM] Executed: git pull origin main
+```
+
+## Publishing to npm
+
+### Prepare for Publishing
+
+1. Update `package.json` with your details:
+
+```json
+{
+  "name": "cmdvault",
+  "author": "Your Name <your.email@example.com>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/yourusername/cmdvault"
+  }
+}
+```
+
+2. Create an npm account:
+
+```bash
+npm adduser
+```
+
+3. Publish:
+
+```bash
+npm publish
+```
+
+### Install from npm
+
+Once published, users can install globally:
+
+```bash
+npm install -g cmdvault
+```
+
+## Project Structure
+
+```
+smart-term/
+├── bin/
+│   └── cm.js              # Executable entry point
+├── lib/
+│   ├── storage.js         # Command storage management
+│   ├── executor.js        # Command execution with streaming
+│   └── editor.js          # Editor integration
+├── index.js               # Main CLI logic
+├── package.json           # Package configuration
+└── README.md             # Documentation
+```
+
+## Requirements
+
+- Node.js >= 14.0.0
+- npm or yarn
+
+## Dependencies
+
+- **commander** - CLI framework
+- **chalk** - Terminal colors
+- **cli-table3** - Beautiful tables
+
+## Troubleshooting
+
+### Command not found: cm
+
+After installation, if `cm` is not recognized:
+
+```bash
+# Re-link the package
+npm link
+
+# Or check your PATH includes npm global bin
+npm config get prefix
+```
+
+### Permission denied
+
+On Linux/Mac, you may need to make the bin file executable:
+
+```bash
+chmod +x bin/cm.js
+```
+
+### Editor not opening
+
+Set your preferred editor:
+
+```bash
+# Linux/Mac
+export EDITOR=nano
+# or
+export EDITOR=vim
+
+# Windows
+set EDITOR=notepad
+```
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## Support
+
+For issues and questions, please open an issue on GitHub.

package/bin/cm.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../index.js');