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
✨ What is VibeStudio?
VibeStudio is a powerful command-line AI workflow tool that enhances your development workflow with advanced code understanding, automated tasks, and intelligent assistance. Built for developers who want to supercharge their productivity without leaving the terminal.
🎯 Why VibeStudio?
- 🚀 Instant Setup - Get started in seconds with our streamlined authentication
- 🧠 Smart Context - Understands your entire codebase, not just individual files
- ⚡ Lightning Fast - Terminal-native speed with powerful AI capabilities
- 🔐 Privacy First - Your code stays on your machine, secure authentication
- 💳 Transparent Pricing - Clear credit system, free tier included
Installation
Prerequisites
Ensure you have Node.js version 20 or higher installed.
Install from npm
npm install -g vibestudio
vibestudio --version
🚀 Quick Start
# Install VibeStudio
npm install -g vibestudio
# Start your first session
vibestudio
# Authenticate (follow the prompts)
# Press Ctrl+1 or type /auth
# Start building!
> Explain this codebase structure
> Help me refactor this function
> Generate unit tests for this module
📺 See VibeStudio in Action
# Smart codebase analysis
> What are the main components of this React app?
> Find all API endpoints and their purposes
# Intelligent code generation
> Create a user authentication system
> Generate comprehensive tests for the auth module
# Automated improvements
> Refactor this component to use TypeScript
> Add error handling to all async functions
Authentication
VibeStudio uses a streamlined authentication flow designed for developers:
Getting Started with VibeStudio
Launch VibeStudio
vibestudio
Authenticate with VibeStudio
- When you first start, you'll see authentication options
- Press Ctrl+1 or run
/auth
command - Follow the guided authentication flow
- Sign in with your VibeStudio account
Verify Authentication
# Check your credit balance /credits # View authentication status /auth
Authentication Features
- 🔐 Secure OAuth Flow - Industry-standard authentication
- 🆓 Free Tier Included - Get started immediately with free credits
- 💳 Credit System - Transparent usage tracking
- 🔄 Auto-renewal - Seamless session management
- 🛡️ Privacy First - Your code stays on your machine
Managing Authentication
# View current authentication status
/auth
# Switch or refresh authentication
/auth
# Check remaining credits
/credits
# View help for authentication commands
/help
Key Features
🧠 Intelligent Code Analysis
- Deep Codebase Understanding - Analyze complex project structures and dependencies
- Context-Aware Responses - Understands your specific codebase and coding patterns
- Multi-Language Support - Works with JavaScript, Python, TypeScript, Go, Rust, and more
⚡ Productivity Tools
- Smart Code Generation - Create functions, classes, tests, and documentation
- Automated Refactoring - Improve code quality and performance safely
- Bug Detection & Fixes - Identify and resolve issues across your codebase
- Git Integration - Smart commit messages and code reviews
🛠️ Developer Workflow
- File Operations - Read, write, and modify files with intelligent suggestions
- Shell Integration - Execute commands with safety checks and explanations
- Memory System - Remembers your preferences and project context
- Customizable Prompts - Use VIBESTUDIO.md files to personalize responses
🔧 Advanced Capabilities
- Tool Execution - Run builds, tests, and linters automatically
- Documentation Generation - Create comprehensive project documentation
- Code Migration - Upgrade frameworks and migrate between languages
- Security Analysis - Identify potential security vulnerabilities
Usage Examples
Code Analysis
> What are the main components of this system?
> Find all API endpoints in this codebase
> Identify potential security issues
Code Generation
> Create unit tests for this function
> Generate documentation for this API
> Refactor this code to improve performance
Automation
> Convert all console.log to proper logging
> Update all deprecated API calls
> Generate a changelog from recent commits
Commands
Essential Commands
/help
- Show available commands and features/auth
- Authenticate with VibeStudio or change authentication/credits
- Check your remaining VibeStudio credits/clear
- Clear conversation history/exit
- Exit VibeStudio safely
Advanced Commands
/memory
- View or modify your saved preferences/docs
- Access VibeStudio documentation/bug
- Report issues or provide feedback
Pro Tips
- Use Ctrl+C twice to exit quickly
- Create VIBESTUDIO.md files to customize behavior per project
- Use @filename to reference specific files in conversations
License
Apache 2.0 License - see LICENSE file for details.