A powerful CLI tool that converts natural language descriptions into shell commands using the Cerebras AI API. Built with Bun and TypeScript for fast performance and excellent developer experience.
- AI-Powered Command Generation - Convert natural language to shell commands using Cerebras AI
- OS-Aware - Automatically detects your operating system and generates appropriate commands
- Safety Classification - Commands are classified as safe, caution, or dangerous
- Fast Execution - Built with Bun runtime for optimal performance
- Command Explanation - Get detailed explanations of generated commands
- Command Analysis - Analyze and fix failed commands with AI assistance
- Global CLI - Install once, use anywhere with
vcmd - Interactive Configuration - Easy setup with guided prompts
- Natural Syntax - Use intuitive "can you" syntax or direct requests
- Auto-Update - Keep your CLI tool up to date with built-in update command
** Package:** void-cmd on npm
# Install globally with npm
npm install -g void-cmd
# Install globally with Bun
bun install -g void-cmd
# Install globally with yarn
yarn global add void-cmd
# Install globally with pnpm
pnpm install -g void-cmdgit clone https://github.com/xptea/vcmd.git
cd vcmd
bun install
npm run install-global# Configure API key
vcmd -settings
# Start using
vcmd can you list all files
vcmd make sure that ip 1.1.1.1 is online# Natural syntax (recommended)
vcmd list all files in current directory
vcmd can you see if this ip 1.1.1.1 is online
vcmd find all JavaScript files modified in the last 7 days
vcmd create a backup of my home directory
vcmd show disk usage for all mounted drives
# Both syntaxes work
vcmd can you list all files
vcmd list all files# Analyze any command interactively
vcmd -e
# Analyze a specific command
vcmd -e "ping 1.1.1.1.1"
vcmd -e ping 1.1.1.1.1
# Example workflow:
ping 1.1.1.1.1 # This fails
vcmd -e "ping 1.1.1.1.1"# Get AI analysis and fixesvcmd -settings # Configure API key, model, etc.
vcmd -update # Check for updates
vcmd -update --auto # Automatically update
vcmd -help # Show helpPackage Name:void-cmd
Command Name:vcmd
NPM Package:https://www.npmjs.com/package/void-cmd
# All of these install the 'vcmd' command globally:
npm install -g void-cmd
bun install -g void-cmd
yarn global add void-cmd
pnpm install -g void-cmdAfter installation, use the vcmd command anywhere in your terminal.
When you use vcmd -e, you get:
- Intelligent Analysis - AI examines what went wrong with your command
- Suggested Fixes - Get corrected versions of failed commands
- Alternative Commands - Multiple ways to achieve the same goal
- Interactive Execution - Execute suggested fixes directly from the menu
- Detailed Explanations - Understand how commands work
$ ping 1.1.1.1.1
ping: 1.1.1.1.1: Name or service not known
$ vcmd -e "ping 1.1.1.1.1"
==== VCMD By Voidworks.xyz ====
Command Analysis & Suggestions:
====================================
Original Command: ping 1.1.1.1.1
Analysis:
The command has a malformed IP address. "1.1.1.1.1" is not a valid IPv4 address format...
Suggested Fix:
ping -c 4 1.1.1.1
Alternative Commands:
1. ping -c 4 8.8.8.8
2. ping -c 4 google.com
? What would you like to do?
🔧 Execute Suggested Fix: ping -c 4 1.1.1.1
🔄 Execute Alternative 1: ping -c 4 8.8.8.8
🔄 Execute Alternative 2: ping -c 4 google.com
❯ 📖 Get detailed explanation
❌ ExitVCMD automatically detects your operating system and generates appropriate commands:
| Request | Windows | Linux/macOS |
|---|---|---|
| List files | dir /a | ls -la |
| View file content | type filename.txt | cat filename.txt |
| Check connectivity | ping -n 4 1.1.1.1 | ping -c 4 1.1.1.1 |
| Network info | netstat -an | netstat -tuln |
All commands are classified for safety:
- ✅ SAFE - Read-only operations (listing files, checking status)
⚠️ CAUTION - File modifications, system changes- 🚨 DANGEROUS - Destructive operations requiring confirmation
Settings are stored in ~/.vcmd-settings.json:
{
"apiKey": "csk-your-api-key-here",
"baseUrl": "https://api.cerebras.ai/v1",
"model": "llama3.1-8b"
}- Visit Cerebras Cloud
- Sign up for an account
- Generate an API key
- Run
vcmd -settingsto configure
VCMD includes a built-in update system:
# Check for updates
vcmd -update
# Automatically update to latest version
vcmd -update --auto
# Manual update
npm update -g void-cmd
# or
bun update -g void-cmd# Development with auto-reload
bun run dev
# Build for production
bun run build
# Install globally for testing
npm run install-global
# Remove global installation
npm run uninstall-global| Command | Description |
|---|---|
vcmd [request] | Convert natural language to shell command |
vcmd can you [request] | Alternative natural language syntax |
vcmd -e | Analyze command interactively |
vcmd -e "command" | Analyze specific command |
vcmd -settings | Configure API key and settings |
vcmd -update | Check for updates |
vcmd -update --auto | Automatically update |
vcmd -help | Show help information |
vcmd list all hidden files
vcmd find files larger than 100MB
vcmd compress all log files in /var/log
vcmd show permissions forall filesin current directoryvcmd check if google.com is reachable
vcmd show all listening ports
vcmd display system memory usage
vcmd find process using port 3000vcmd find all Python files with TODO comments
vcmd count lines of code in all JavaScript files
vcmd show git commits from last week
vcmd install package.json dependencies# If you see "API key not configured"
vcmd -settings
# Verify your settings
cat ~/.vcmd-settings.json# Make sure you provide the command correctly
vcmd -e "your-failed-command"# For interactive mode
vcmd -e# Check current version
vcmd -update
# Force update
npm update -g void-cmd
# or
bun update -g void-cmd# If global install fails
sudo npm install -g void-cmd
# Or use local development
bun run dev [your command]# Remove global command
npm uninstall -g void-cmd
# or
bun remove -g void-cmd
# Remove settings and history
rm ~/.vcmd-settings.json
rm ~/.vcmd-history.jsonWe welcome contributions! Here's how:
- Fork the repository
- Create a feature branch:
git checkout -b feature-name - Make your changes
- Add tests if applicable
- Submit a pull request
git clone https://github.com/xptea/vcmd.git
cd vcmd
bun install
bun run devThis project is licensed under the MIT License - see the LICENSE file for details.
- NPM Package:https://www.npmjs.com/package/void-cmd
- GitHub Repository:https://github.com/xptea/vcmd
- Bug Reports:https://github.com/xptea/vcmd/issues
- Built with Bun for fast JavaScript runtime
- Powered by Cerebras AI for intelligent command generation
- Uses Inquirer.js for interactive prompts
Made with ❤️ by VoidWorks.xyz
Transform your natural language into powerful shell commands with AI assistance!