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
Intelligent command-line assistant for software development
Installation • Quick Start • Features • Documentation • Contributing
VibeStudio is an advanced command-line development assistant built from Gemini CLI (details), specifically enhanced for VibeStudio-Coder models. It streamlines your development process with intelligent code analysis, automated task execution, and comprehensive project assistance.
💡 Free Access Options
Start using VibeStudio immediately with these complimentary options:
🔥 VibeStudio OAuth (Recommended)
- 2,000 daily requests with unlimited token usage
- 60 requests per minute rate limit
- Run
vibestudio
and authenticate with your VibeStudio account - Automatic credential management and renewal
- Use
/auth
command to switch to VibeStudio OAuth if you started with OpenAI compatible mode
🌏 Regional Free Tiers
- Mainland China: ModelScope provides 2,000 complimentary API calls daily
- International: OpenRouter offers up to 1,000 complimentary API calls daily globally
For detailed setup instructions, see Authorization.
[!WARNING] Token Usage Notice: VibeStudio may make multiple API calls per cycle, resulting in higher token consumption (similar to Claude Code). We're actively optimizing API efficiency.
Key Features
- Intelligent Code Analysis & Editing - Analyze and modify large codebases beyond traditional context limitations
- Automated Workflow Management - Automate operational tasks including pull request handling and complex rebases
- Optimized Parser - Custom parser specifically enhanced for VibeStudio-Coder models
Installation
Prerequisites
Ensure you have Node.js version 20 or higher installed.
curl -qL https://www.npmjs.com/install.sh | sh
Install from npm
npm install -g vibestudio
vibestudio --version
Install from source
git clone https://github.com/vibestudio-ai/vibestudio.git
cd vibestudio
npm install
npm install -g .
Install globally with Homebrew (macOS/Linux)
brew install vibestudio
Quick Start
# Launch VibeStudio
vibestudio
# Example commands
> Analyze this codebase architecture
> Refactor this function for better performance
> Create comprehensive unit tests for this module
Session Management
Manage your token consumption with configurable session limits to optimize costs and performance.
Configure Session Token Limit
Create or edit .vibestudio/settings.json
in your home directory:
{
"sessionTokenLimit": 32000
}
Session Commands
/compress
- Compress conversation history to stay within token limits/clear
- Clear all conversation history and start fresh/stats
- Check current token usage and limits
📝 Note: Session token limit applies to a single conversation, not cumulative API calls.
Authorization
Select your preferred authentication method based on your requirements:
1. VibeStudio OAuth (🚀 Recommended - Start in 30 seconds)
The simplest way to begin - completely free with generous quotas:
# Simply run this command and follow the browser authentication
vibestudio
What happens:
- Instant Setup: CLI opens your browser automatically
- One-Click Login: Authenticate with your vibestudio.ai account
- Automatic Management: Credentials cached locally for future use
- No Configuration: Zero setup required - just start coding!
Free Tier Benefits:
- ✅ 2,000 requests/day (no token counting needed)
- ✅ 60 requests/minute rate limit
- ✅ Automatic credential refresh
- ✅ Zero cost for individual users
- ℹ️ Note: Model fallback may occur to maintain service quality
2. OpenAI-Compatible API
Use API keys for OpenAI or other compatible providers:
Configuration Methods:
Environment Variables
export OPENAI_API_KEY="your_api_key_here" export OPENAI_BASE_URL="your_api_endpoint" export OPENAI_MODEL="your_model_choice"
Project
.env
File Create a.env
file in your project root:OPENAI_API_KEY=your_api_key_here OPENAI_BASE_URL=your_api_endpoint OPENAI_MODEL=your_model_choice
API Provider Options
⚠️ Regional Notice:
- Mainland China: Use Cloud Bailian or ModelScope
- International: Use Cloud ModelStudio or OpenRouter
🇨🇳 For Users in Mainland China
Option 1: Cloud Bailian (Apply for API Key)
export OPENAI_API_KEY="your_api_key_here"
export OPENAI_BASE_URL="https://dashscope.aliyuncs.com/compatible-mode/v1"
export OPENAI_MODEL="vibestudio3-coder-plus"
Option 2: ModelScope (Free Tier) (Apply for API Key)
- ✅ 2,000 free API calls per day
- ⚠️ Connect your Aliyun account to avoid authentication errors
export OPENAI_API_KEY="your_api_key_here"
export OPENAI_BASE_URL="https://api-inference.modelscope.cn/v1"
export OPENAI_MODEL="kimi-vibecoder"
🌍 For International Users
Option 1: Cloud ModelStudio (Apply for API Key)
export OPENAI_API_KEY="your_api_key_here"
export OPENAI_BASE_URL="https://dashscope-intl.aliyuncs.com/compatible-mode/v1"
export OPENAI_MODEL="vibestudio3-coder-plus"
Option 2: OpenRouter (Free Tier Available) (Apply for API Key)
export OPENAI_API_KEY="your_api_key_here"
export OPENAI_BASE_URL="https://openrouter.ai/api/v1"
export OPENAI_MODEL="vibestudio/vibestudio3-coder:free"
Usage Examples
🔍 Explore Codebases
cd your-project/
vibestudio
# Architecture analysis
> Describe the main pieces of this system's architecture
> What are the key dependencies and how do they interact?
> Find all API endpoints and their authentication methods
💻 Code Development
# Refactoring
> Refactor this function to improve readability and performance
> Convert this class to use dependency injection
> Split this large module into smaller, focused components
# Code generation
> Create a REST API endpoint for user management
> Generate unit tests for the authentication module
> Add error handling to all database operations
🔄 Automate Workflows
# Git automation
> Analyze git commits from the last 7 days, grouped by feature
> Create a changelog from recent commits
> Find all TODO comments and create GitHub issues
# File operations
> Convert all images in this directory to PNG format
> Rename all test files to follow the *.test.ts pattern
> Find and remove all console.log statements
🐛 Debugging & Analysis
# Performance analysis
> Identify performance bottlenecks in this React component
> Find all N+1 query problems in the codebase
# Security audit
> Check for potential SQL injection vulnerabilities
> Find all hardcoded credentials or API keys
Popular Tasks
📚 Understand New Codebases
> What are the core business logic components?
> What security mechanisms are in place?
> How does the data flow through the system?
> What are the main design patterns used?
> Generate a dependency graph for this module
🔨 Code Refactoring & Optimization
> What parts of this module can be optimized?
> Help me refactor this class to follow SOLID principles
> Add proper error handling and logging
> Convert callbacks to async/await pattern
> Implement caching for expensive operations
📝 Documentation & Testing
> Generate comprehensive JSDoc comments for all public APIs
> Write unit tests with edge cases for this component
> Create API documentation in OpenAPI format
> Add inline comments explaining complex algorithms
> Generate a README for this module
🚀 Development Acceleration
> Set up a new Express server with authentication
> Create a React component with TypeScript and tests
> Implement a rate limiter middleware
> Add database migrations for new schema
> Configure CI/CD pipeline for this project
Commands & Shortcuts
Session Commands
/help
- Display available commands/clear
- Clear conversation history/compress
- Compress history to save tokens/stats
- Show current session information/exit
or/quit
- Exit VibeStudio
Keyboard Shortcuts
Ctrl+C
- Cancel current operationCtrl+D
- Exit (on empty line)Up/Down
- Navigate command history
Benchmark Results
Terminal-Bench Performance
Agent | Model | Accuracy |
---|---|---|
VibeStudio | VibeStudio-Coder-480A35 | 37.5% |
VibeStudio | VibeStudio-Coder-30BA3B | 31.3% |
Development & Contributing
See CONTRIBUTING.md to learn how to contribute to the project.
For detailed authentication setup, see the authentication guide.
Troubleshooting
If you encounter issues, check the troubleshooting guide.
Acknowledgments
This project is based on Google Gemini CLI. We acknowledge and appreciate the excellent work of the Gemini CLI team. Our main contribution focuses on parser-level adaptations to better support VibeStudio-Coder models.