JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 60
  • Score
    100M100P100Q91523F

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vibestudio) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    VibeStudio CLI

    VibeStudio Logo

    Intelligent AI-powered command-line assistant for developers

    VibeStudio CLI is your personal AI coding assistant that helps with code analysis, debugging, refactoring, and development tasks directly from your terminal.

    Installation

    Install VibeStudio globally using npm:

    npm install -g vibestudio

    Verify the installation:

    vibestudio --version

    Getting Started

    1. Create Your Account

    Visit https://www.vibestud.io/ to create your free account:

    1. Sign Up: Click "Sign Up" and provide your email and password
    2. Account Setup: Complete your profile setup

    2. Get Your API Credits

    VibeStudio operates on a credit-based system.

    To purchase credits:

    3. Authentication

    Run VibeStudio for the first time:

    vibestudio

    You'll be prompted to authenticate with your VibeStudio account:

    1. Enter your email and password
    2. CLI will automatically manage your session and credits

    Basic Usage

    Once authenticated, start chatting with your AI assistant:

    vibestudio

    Example conversations:

    > Build a REST API for user authentication with JWT tokens

> Convert this class-based React component to hooks

> Optimize this SQL query that's running slowly

> Write comprehensive tests for this payment processing module

> Set up Docker containerization for this Node.js application

> Implement real-time notifications using WebSockets

> Create a responsive dashboard with charts and analytics

> Add proper error handling and logging to this microservice

    Non-Interactive Mode

    For scripting and automation:

    # Analyze a specific file
echo "What does this file do?" | vibestudio -p "Analyze the main.py file"

# Get code suggestions
vibestudio -p "How can I optimize this React component for performance?"

# Generate documentation
vibestudio -i "Create comprehensive documentation for this API"

    Commands Reference

    Interactive Session Commands

    Use these commands during your VibeStudio session:

    Core Commands:

    • /help - Show available commands and usage
    • /clear - Clear conversation history
    • /quit - Exit VibeStudio (also /exit)
    • /credits - Check remaining credits
    • /auth - Re-authenticate or switch accounts
    • /signout - Sign out from current account

    Chat & Memory:

    • /compress - Compress conversation history to save tokens
    • /memory - Show conversation memory usage
    • /stats - Display session statistics
    • /summary - Generate conversation summary

    Configuration:

    • /settings - Configure VibeStudio preferences
    • /theme - Change visual theme
    • /vim - Toggle vim keybindings
    • /editor - Configure external editor integration

    Advanced Features:

    • /mcp - Manage MCP (Model Context Protocol) servers
    • /agents - View available AI agents
    • /tools - List available tools
    • /extensions - Manage extensions
    • /copy - Copy conversation or code snippets

    Command Line Options

    Run vibestudio --help for all options. Key flags include:

    Basic Usage:

    vibestudio                    # Launch interactive mode
vibestudio -p "your prompt"   # Non-interactive mode
vibestudio -i "your prompt"   # Execute prompt then continue interactively
vibestudio --version          # Show version

    Development Options:

    vibestudio --debug           # Enable debug mode
vibestudio --sandbox         # Run in sandbox mode
vibestudio --yolo           # Auto-approve all actions (use with caution!)
vibestudio --all-files      # Include ALL files in context

    Features

    🤖 AI-Powered Development

    • Code Analysis: Understand complex codebases quickly
    • Bug Detection: Find and fix issues in your code
    • Refactoring: Improve code quality and performance
    • Testing: Generate comprehensive test suites

    💬 Natural Conversations

    • Chat naturally about your code
    • Ask follow-up questions
    • Get explanations in plain English
    • Request specific code modifications

    🔧 Developer Tools Integration

    • Works with any programming language
    • Integrates with your existing workflow
    • Supports multiple file formats
    • Context-aware suggestions

    🎯 Smart Context Understanding

    • Analyzes entire project structure
    • Remembers conversation context
    • Provides relevant suggestions
    • Learns from your coding patterns

    🛡️ Secure Sandbox Environment

    • Isolated Execution: Code runs in secure sandbox containers
    • File System Protection: Your local files remain safe
    • Network Security: Controlled network access
    • Resource Limits: CPU and memory usage controlled
    • Multi-Platform: Works on macOS, Linux, and Windows

    Credit Usage

    How Credits Work

    • Credits are deducted based on input and output length
    • Complex queries may use more credits
    • Simple questions typically use 1-3 credits

    Typical Credit Costs

    • Simple question: 1-2 credits
    • Code analysis: 3-5 credits
    • Code generation: 5-10 credits
    • Large file processing: 10-20 credits

    Managing Your Credits

    • Monitor usage with /credits command
    • Set up billing alerts in dashboard
    • Purchase credits before running out
    • Use /credits history to track spending

    Account Management

    Billing & Payments

    • Payment Methods: Multiple payment options available
    • Invoices: Download receipts for business expenses
    • Refunds: Contact info@vibestud.io for refund requests
    • Enterprise: Custom billing arrangements available

    Troubleshooting

    Authentication Issues

    • Use /signout command in interactive mode to sign out
    • Use /auth command to re-authenticate
    • Restart VibeStudio if authentication issues persist

    Credit Problems

    • Use /credits command to check current balance
    • Purchase more credits at www.vibestud.io
    • Contact support if credits aren't reflecting correctly

    Connection Issues

    • Ensure stable internet connection
    • Check if firewall blocks vibestudio.ai
    • Try switching networks if available

    Common Error Messages

    "Insufficient Credits"

    "Authentication Failed"

    • Check email/password combination
    • Reset password if necessary
    • Contact support for account issues

    "Network Error"

    • Check internet connection
    • Verify vibestudio.ai accessibility
    • Contact support if service is down

    Support

    Getting Help

    Response Times

    • Standard Support: 4-8 hours
    • Enterprise: 1-2 hours

    Privacy & Security

    • Data Encryption: All communications encrypted in transit
    • No Code Storage: Your code is not permanently stored
    • GDPR Compliant: Full compliance with privacy regulations
    • SOC 2 Type II: Enterprise-grade security standards

    Ready to boost your development workflow?

    npm install -g vibestudio
vibestudio

    Start coding smarter, not harder! 🚀