<h1 align="center">
<a href="https://prompts.chat">
<img height="72" src="https://github.com/user-attachments/assets/45eff178-242f-4d84-863e-247b080cc6f5" />
Sign in to like and favorite skills
vibe-tools is optimized for Cursor Composer Agent but it can be used by any coding agent that can execute commands
After installation, to see AI teamwork in action just ask Cursor Composer to use Perplexity or Gemini. Here are two examples:
vibe-tools provides a CLI that your AI agent can use to expand its capabilities. vibe-tools is designed to be installed globally, providing system-wide access to its powerful features. When you run vibe-tools install, it configures instruction files tailored to your chosen development environment:
.cursorrules or .cursor/rules/vibe-tools.mdc.CLAUDE.md (local or global ~/.claude/CLAUDE.md).codex.md (local or global ~/.codex/instructions.md)..windsurfrules..clinerules directory (with vibe-tools.md) or legacy file.vibe-tools supports multiple AI instruction sources including Claude code, Codex, and IDE-specific rules, ensuring compatibility across various AI-powered development setups.
vibe-tools integrates with multiple AI providers including OpenAI, Anthropic, Gemini, Perplexity, OpenRouter, ModelBox, and xAI (Grok).
vibe-tools requires a Perplexity API key and a Google AI API key.
vibe-tools is a node package that should be installed globally.
Install vibe-tools globally:
npm install -g vibe-tools
Then run the setup:
vibe-tools install .
This command will:
.cursorrules for Cursor, CLAUDE.md for Claude Code, .windsurfrules for Windsurf, etc.).For automated environments,
vibe-tools install automatically detects CI environments and runs in non-interactive mode:
# CI environments - automatically detected and runs without prompts CI=true vibe-tools install . # Or explicitly set non-interactive mode NONINTERACTIVE=true vibe-tools install .
In non-interactive mode, vibe-tools will:
VIBE_TOOLS_NO_TELEMETRY=1)vibe-tools installact, extract, and observe commands)vibe-tools uses Gemini-2.5 models by default, which provide excellent performance with large context windows up to 2 million tokens - enough to handle an entire codebase in one shot. Available Gemini models include gemini-2.5-flash (default for speed), gemini-2.5-pro (default for quality), and gemini-2.5-flash-lite-preview-06-17 (lightweight option). Gemini models are currently free to use on Google and you need a Google Cloud project to create an API key.
vibe-tools uses Perplexity because Perplexity has the best web search api and indexes and it does not hallucinate. Perplexity Pro users can get an API key with their pro account and recieve $5/month of free credits (at time of writing). Support for Google search grounding is coming soon but so far testing has shown it still frequently hallucinates things like APIs and libraries that don't exist.
vibe-tools collects anonymous usage telemetry to help improve the tool. You will be prompted during installation to enable or disable telemetry, and you can opt out at any time. No code, queries, file contents, or personal data are ever collected—only high-level command usage and error types (see TELEMETRY.md for full details).
VIBE_TOOLS_NO_TELEMETRY=1 environment variable.If you do something cool with
vibe-tools please let me know on twitter or make a PR to add to this section!
To see vibe-tools GitHub and Perplexity skills: Check out this example issue that was solved using Cursor agent and vibe-tools
See cursor get approximately 5x more work done per-prompt with Gemini code review:
Use Cursor Composer in agent mode with command execution (not sure what this means, see section below on Cursor Agent configuration). If you have installed the vibe-tools prompt to your .cursorrules (or equivalent) just ask your AI coding agent/assistant to use "vibe-tools" to do things.
vibe-tools ask allows direct querying of any model from any provider. It's best for simple questions where you want to use a specific model or compare responses from different models.vibe-tools web uses an AI teammate with web search capability to answer questions. web is best for finding up-to-date information from the web that is not specific to the repository such as how to use a library to search for known issues and error messages or to get suggestions on how to do something. Web is a teammate who knows tons of stuff and is always up to date.vibe-tools repo uses an AI teammate with large context window capability to answer questions. repo sends the entire repo as context so it is ideal for questions about how things work or where to find something, it is also great for code review, debugging and planning. With the --with-diff flag, it can also include git diff information for focused code review that keeps the AI focused on current changes while maintaining full codebase understanding. is a teammate who knows the entire codebase inside out and understands how everything works together.vibe-tools plan uses an AI teammate with reasoning capability to plan complex tasks. Plan uses a two step process. First it does a whole repo search with a large context window model to find relevant files. Then it sends only those files as context to a thinking model to generate a plan it is great for planning complex tasks and for debugging and refactoring. Plan is a teammate who is really smart on a well defined problem, although doesn't consider the bigger picture.vibe-tools doc uses an AI teammate with large context window capability to generate documentation for local or github hosted repositories by sending the entire repo as context. doc can be given precise documentation tasks or can be asked to generate complete docs from scratch it is great for generating docs updates or for generating local documentation for a libary or API that you use! Doc is a teammate who is great at summarising and explaining code, in this repo or in any other repo!vibe-tools browser uses an AI teammate with browser control (aka operator) capability to operate web browsers. browser can operate in a hidden (headless) mode to invisibly test and debug web apps or it can be used to connect to an existing browser session to interactively share your browser with Cursor agent it is great for testing and debugging web apps and for carrying out any task that can be done in a browser such as reading information from a bug ticket or even filling out a form. Browser is a teammate who can help you test and debug web apps, and can share control of your browser to perform small browser-based tasks.vibe-tools youtube uses an AI teammate with video analysis capability to understand YouTube content. youtube can generate summaries, extract transcripts, create implementation plans from tutorials, and answer specific questions about video content. It's great for extracting value from technical talks, tutorials, and presentations without spending time watching the entire video. YouTube is a teammate who can watch and analyze videos for you, distilling the key information.Note: For repo, doc and plan commands the repository content that is sent as context can be reduced by filtering out files in a .repomixignore file.
When using vibe-tools with Cursor Composer, you can use these nicknames:
vibe-tools repovibe-tools webvibe-tools browser"Please implement country specific stripe payment pages for the USA, UK, France and Germany. Use vibe-tools web to check the available stripe payment methods in each country."
Note: in most cases you can say "ask Perplexity" instead of "use vibe-tools web" and it will work the same.
"Let's refactor our User class to allow multiple email aliases per user. Use vibe-tools repo to ask for a plan including a list of all files that need to be changed."
"Use vibe-tools repo to analyze how authentication is implemented in the Next.js repository. Use --from-github=vercel/next.js."
"Use vibe-tools repo to explain this React component with documentation from the official React docs. Use --with-doc=https://react.dev/reference/react/useState or a local file path"
"Use vibe-tools repo to review my recent changes and suggest improvements. Use --with-diff to include the git diff."
"Use vibe-tools repo to check if my changes are compatible with the main branch. Use --with-diff --base=main."
Note: in most cases you can say "ask Gemini" instead of "use vibe-tools repo" and it will work the same.
"Use vibe-tools to generate documentation for the Github repo https://github.com/kait-http/kaito" and write it to docs/kaito.md"
Note: in most cases you can say "generate documentation" instead of "use vibe-tools doc" and it will work the same.
"Use vibe-tools github to fetch issue 123 and suggest a solution to the user's problem"
"Use vibe-tools github to fetch PR 321 and see if you can fix Andy's latest comment"
Note: in most cases you can say "fetch issue 123" or "fetch PR 321" instead of "use vibe-tools github" and it will work the same.
"Use vibe-tools linear to set up authentication with Linear"
"Use vibe-tools linear to fetch issue ITE-123 and provide a summary of the current status"
"Use vibe-tools linear to get issue ABC-456 and explain what the team is discussing in the comments"
Note: in most cases you can say "fetch Linear issue ITE-123" or "get Linear issue ABC-456" instead of "use vibe-tools linear" and it will work the same.
"Use vibe-tools to open the users page and check the error in the console logs, fix it"
"Use vibe-tools to test the form field validation logic. Take screenshots of each state"
"Use vibe-tools to open https://example.com/foo the and check the error in the network logs, what could be causing it?"
Note: in most cases you can say "Use Stagehand" instead of "use vibe-tools" and it will work the same.
"Use vibe-tools ask to compare how different models answer this question: 'What are the key differences between REST and GraphQL?'"
"Ask OpenAI's o3-mini model to explain the concept of dependency injection."
"Use vibe-tools ask to analyze this complex algorithm with high reasoning effort: 'Explain the time and space complexity of the Boyer-Moore string search algorithm' --provider openai --model o3-mini --reasoning-effort high"
Note: The ask command requires both --provider and --model parameters to be specified. This command is generally less useful than other commands like
repo or plan because it does not include any context from your codebase or repository.
Ask Command Options:
--provider=<provider>: AI provider to use (openai, anthropic, perplexity, gemini, modelbox, openrouter, xai, or groq)--model=<model>: Model to use (required for the ask command)--max-tokens=<number>: Maximum tokens for response--reasoning-effort=<low|medium|high>: Control the depth of reasoning for supported models (OpenAI o1/o3-mini models, Claude 4 Sonnet, and XAI Grok models). Higher values produce more thorough responses for complex questions.--with-doc=<doc_url>: Fetch content from one or more document URLs and include it as context. Can be specified multiple times (e.g., --with-doc=<url1> --with-doc=<url2>).vibe-tools requires API keys for Perplexity AI, Google Gemini, and optionally for OpenAI, Anthropic, OpenRouter, and xAI. These can be configured in two ways:
vibe-tools install and follow the prompts~/.vibe-tools/.env in your home directory or .vibe-tools.env in your project root:
PERPLEXITY_API_KEY="your-perplexity-api-key" GEMINI_API_KEY="your-gemini-api-key" OPENAI_API_KEY="your-openai-api-key" # Optional, for Stagehand ANTHROPIC_API_KEY="your-anthropic-api-key" # Optional, for Stagehand and MCP OPENROUTER_API_KEY="your-openrouter-api-key" # Optional, for MCP XAI_API_KEY="your-xai-api-key" # Optional, for xAI Grok models GROQ_API_KEY="your-groq-api-key" # Optional, for Groq models GITHUB_TOKEN="your-github-token" # Optional, for enhanced GitHub access LINEAR_API_KEY="your-linear-api-key" # Optional, for Linear integration
ANTHROPIC_API_KEY and OPENROUTER_API_KEY must be provided to use the mcp commands.CI/CD Environments: In non-interactive mode (automatically detected in CI environments), vibe-tools uses only environment variables for API keys and skips writing them to filesystem for enhanced security.
vibe-tools supports multiple authentication methods for accessing the Google Gemini API, providing flexibility for different environments and security requirements. You can choose from the following methods:
API Key (Default)
GEMINI_API_KEY environment variable to your API key string obtained from Google AI Studio.GEMINI_API_KEY="your-api-key-here"
Service Account JSON Key File
GEMINI_API_KEY environment variable to the path of your downloaded service account JSON key file.GEMINI_API_KEY="./path/to/service-account.json"
gemini-2.5-flash.Automatic Doppler Secrets Manager Integration (new in 0.63.x)
doppler setup, vibe-tools will automatically run doppler secrets --json at startup and load any secrets whose names end with _API_KEY into the current process before it evaluates which providers are available.OPENAI_API_KEY, ANTHROPIC_API_KEY, GEMINI_API_KEY, etc.) in Doppler and skip copying them into .env files.vibe-tools.config.json:
{ "disableDoppler": true }
Environment Variable Precedence with VIBE_TOOLS_ Prefix
VIBE_TOOLS_ to ensure it takes precedence over all other sourcesVIBE_TOOLS_OPENAI_API_KEY will override OPENAI_API_KEY from any source (environment, .env files, or Doppler)# This will use the prefixed key instead of the regular one VIBE_TOOLS_OPENAI_API_KEY="vibe-specific-key" OPENAI_API_KEY="regular-key" vibe-tools ask "Hello"
Application Default Credentials (ADC) for Gemini models (Recommended for Google Cloud Environments)
GEMINI_API_KEY environment variable for Gemini models.vibe-tools within Google Cloud environments (e.g., Compute Engine, Kubernetes Engine) or for local development using gcloud.GEMINI_API_KEY environment variable to adc.GEMINI_API_KEY="adc"
gcloud auth application-default login
Use Perplexity AI to get up-to-date information directly within Cursor:
vibe-tools web "What's new in TypeScript 5.7?"
Leverage Google Gemini 2.0 models with 1M+ token context windows for codebase-aware assistance and implementation planning:
# Get context-aware assistance vibe-tools repo "Explain the authentication flow in this project, which files are involved?" # Generate implementation plans vibe-tools plan "Add user authentication to the login page"
The plan command uses multiple AI models to:
Plan Command Options:
--fileProvider=<provider>: Provider for file identification (gemini, openai, anthropic, perplexity, modelbox, openrouter, xai, or groq)--thinkingProvider=<provider>: Provider for plan generation (gemini, openai, anthropic, perplexity, modelbox, openrouter, xai, or groq)--fileModel=<model>: Model to use for file identification--thinkingModel=<model>: Model to use for plan generation--fileMaxTokens=<number>: Maximum tokens for file identification--thinkingMaxTokens=<number>: Maximum tokens for plan generation--debug: Show detailed error information--with-doc=<doc_url>: Fetch content from one or more web URLs and include it as context during plan generation. Can be specified multiple times (e.g., --with-doc=<url1> --with-doc=<url2>).Repository context is created using Repomix. See repomix configuration section below for details on how to change repomix behaviour.
Above 1M tokens vibe-tools will always send requests to Gemini 2.0 Pro as it is the only model that supports 1M+ tokens.
The Gemini 2.0 Pro context limit is 2M tokens, you can add filters to .repomixignore if your repomix context is above this limit.
Automate browser interactions for web scraping, testing, and debugging:
Note: Playwright browsers are automatically installed when you run
vibe-tools install. No additional setup is required for browser commands.
open - Open a URL and capture page content:# Open and capture HTML content, console logs and network activity (enabled by default) vibe-tools browser open "https://example.com" --html # Take a screenshot vibe-tools browser open "https://example.com" --screenshot=page.png # Debug in an interactive browser session vibe-tools browser open "https://example.com" --connect-to=9222
act - Execute actions using natural language - Agent tells the browser-use agent what to do:# Single action vibe-tools browser act "Login as '[email protected]'" --url "https://example.com/login" # Multi-step workflow using pipe separator vibe-tools browser act "Click Login | Type '[email protected]' into email | Click Submit" --url "https://example.com" # Record interaction video vibe-tools browser act "Fill out registration form" --url "https://example.com/signup" --video="./recordings"
observe - Analyze interactive elements:# Get overview of interactive elements vibe-tools browser observe "What can I interact with?" --url "https://example.com" # Find specific elements vibe-tools browser observe "Find the login form" --url "https://example.com"
extract - Extract data using natural language:# Extract specific content vibe-tools browser extract "Get all product prices" --url "https://example.com/products" # Save extracted content vibe-tools browser extract "Get article text" --url "https://example.com/blog" --html > article.html # Extract with network monitoring vibe-tools browser extract "Get API responses" --url "https://example.com/api-test" --network
mac-chrome - Start a Chrome instance with remote debugging (macOS only):# Launch Chrome with remote debugging on port 9222 vibe-tools browser mac-chrome # Launch with debug output to see the full command vibe-tools browser mac-chrome --debug # Fast start-up with a minimal flag set vibe-tools browser mac-chrome --lite
This command:
--lite)--lite option launches Chrome with a reduced set of flags for quicker startup and fewer side-effectsAll browser commands (
open, act, observe, extract) support these options:
--console: Capture browser console logs (enabled by default, use --no-console to disable)--html: Capture page HTML content (disabled by default)--network: Capture network activity (enabled by default, use --no-network to disable)--screenshot=<file path>: Save a screenshot of the page--timeout=<milliseconds>: Set navigation timeout (default: 120000ms for Stagehand operations, 30000ms for navigation)--viewport=<width>x<height>: Set viewport size (e.g., 1280x720)--headless: Run browser in headless mode (default: true)--no-headless: Show browser UI (non-headless mode) for debugging--connect-to=<port>: Connect to existing Chrome instance. Special values: 'current' (use existing page), 'reload-current' (refresh existing page)--wait=<time:duration or selector:css-selector>: Wait after page load (e.g., 'time:5s', 'selector:#element-id')--video=<directory>: Save a video recording (1280x720 resolution, timestamped subdirectory). Not available when using --connect-to--url=<url>: Required for act, observe, and extract commands--evaluate=<string>: JavaScript code to execute in the browser before the main commandNotes on Connecting to an existing browser session with --connect-to
--connect-to, viewport is only changed if --viewport is explicitly provided--connect-to--connect-to values:
current: Use the existing page without reloadingreload-current: Use the existing page and refresh it (useful in development)All browser commands support video recording of the browser interaction in headless mode (not supported with --connect-to):
--video=<directory> to enable recordingExample:
# Record a video of filling out a form vibe-tools browser act "Fill out registration form with name John Doe" --url "http://localhost:3000/signup" --video="./recordings"
Console logs and network activity are captured by default:
--no-console to disable console logging--no-network to disable network loggingThe
act command supports chaining multiple actions using the pipe (|) separator:
# Login sequence with console/network logging (enabled by default) vibe-tools browser act "Click Login | Type '[email protected]' into email | Click Submit" --url "http://localhost:3000/login" # Form filling with multiple fields vibe-tools browser act "Select 'Mr' from title | Type 'John' into first name | Type 'Doe' into last name | Click Next" --url "http://localhost:3000/register" # Record complex interaction vibe-tools browser act "Fill form | Submit | Verify success" --url "http://localhost:3000/signup" --video="./recordings"
Common issues and solutions:
Element Not Found Errors
--no-headless to visually debug the pagebrowser observe to see what elements Stagehand can identify--timeout)Stagehand API Errors
--modelNetwork Errors
--timeoutVideo Recording Issues
--connect-toPerformance Issues
--headless mode for better performance (default)--viewport--connect-to for developmentBrowser Installation Issues
vibe-tools installSKIP_PLAYWRIGHT=1 and install manuallynpx playwright install chromiumUse Gemini-powered YouTube video analysis to extract insights, summaries, and implementation plans:
# Generate a video summary vibe-tools youtube "https://www.youtube.com/watch?v=VIDEO_ID" --type=summary # Get a detailed transcript vibe-tools youtube "https://www.youtube.com/watch?v=VIDEO_ID" --type=transcript # Create an implementation plan based on tutorial content vibe-tools youtube "https://www.youtube.com/watch?v=VIDEO_ID" --type=plan # Ask specific questions about the video vibe-tools youtube "https://www.youtube.com/watch?v=VIDEO_ID" "How does the authentication flow work?" # Save summary to a file vibe-tools youtube "https://www.youtube.com/watch?v=VIDEO_ID" --type=summary --save-to=video-summary.md
The YouTube command leverages Gemini models' native ability to understand video content, enabling you to:
YouTube Command Options:
--type=<summary|transcript|plan|custom>: Type of analysis to perform (default: summary)Note: The YouTube command requires a
GEMINI_API_KEY to be set in your environment or .vibe-tools.env file as the Gemini API is currently the only interface that reliably supports YouTube video analysis.
Access GitHub issues and pull requests directly from the command line with rich formatting and full context:
# List recent PRs or issues vibe-tools github pr vibe-tools github issue # View specific PR or issue with full discussion vibe-tools github pr 123 vibe-tools github issue 456
The GitHub commands provide:
--review-only, --discussion-only, --metadata-only, --no-links, and --hide-resolved for AI agent optimizationAuthentication Methods: The commands support multiple authentication methods:
GITHUB_TOKEN=your_token_heregh is installed and logged in)Without authentication:
With authentication:
Access Linear issues directly from the command line with rich formatting and full context:
# Set up authentication (interactive prompts) vibe-tools linear connect # View specific issue with full details vibe-tools linear get-issue ITE-123 vibe-tools linear issue ABC-456 # Alternative command name
The Linear commands provide:
ITE-123) and UUID formatAuthentication Methods:
The Linear integration supports two authentication approaches:
Personal API Key (Recommended for individual use):
OAuth2 with PKCE (Recommended for organizational use):
Authentication Setup:
Run the interactive setup command:
vibe-tools linear connect
This will guide you through:
Environment Variable: Alternatively, you can set the
LINEAR_API_KEY environment variable in your .vibe-tools.env file:
LINEAR_API_KEY="your-linear-api-key"
Note: Linear personal API keys should be used directly without a "Bearer" prefix when set as environment variables.
Automate iOS app building, testing, and running in the simulator:
# Available subcommands vibe-tools xcode build # Build Xcode project and report errors vibe-tools xcode run # Build and run app in simulator vibe-tools xcode lint # Analyze code and offer to fix warnings
Build Command Options:
# Specify custom build path (derived data) vibe-tools xcode build buildPath=/custom/build/path # Specify target device vibe-tools xcode build destination="platform=iOS Simulator,name=iPhone 15"
Run Command Options:
# Run on iPhone simulator (default) vibe-tools xcode run iphone # Run on iPad simulator vibe-tools xcode run ipad # Run on specific device with custom build path vibe-tools xcode run device="iPhone 16 Pro" buildPath=/custom/build/path
The Xcode commands provide:
Generate comprehensive documentation for your repository or any GitHub repository:
# Document local repository and save to file vibe-tools doc --save-to=docs.md # Document remote GitHub repository (both formats supported) vibe-tools doc --from-github=username/repo-name@branch vibe-tools doc --from-github=https://github.com/username/repo-name@branch # Save documentation to file (with and without a hint) # This is really useful to generate local documentation for libraries and dependencies vibe-tools doc --from-github=eastlondoner/cursor-tools --save-to=docs/MY_DOCS.md vibe-tools doc --from-github=eastlondoner/cursor-tools --save-to=docs/MY_DOCS.md --hint="only information about the doc command" # Document dependencies vibe-tools doc --from-github=expressjs/express --save-to=docs/EXPRESS.md --quiet # Document with additional web documentation as context vibe-tools doc --from-github=reactjs/react-redux --with-doc=https://redux.js.org/tutorials/fundamentals/part-5-ui-and-react --save-to=docs/REACT_REDUX.md # Document using multiple web documents as context vibe-tools doc --from-github=some/repo --with-doc=https://example.com/spec1 --with-doc=https://example.com/spec2 --save-to=docs/MULTI_DOC.md
vibe-tools wait <seconds>: Pauses execution for the specified number of seconds. Useful for simple timing needs within scripts or chained commands.Customize
vibe-tools behavior by creating a vibe-tools.config.json file. This file can be created either globally in ~/.vibe-tools/vibe-tools.config.json or locally in your project root.
The vibe-tools.config file configures the local default behaviour for each command and provider.
Here is an example of a typical vibe-tools.config.json file, showing some of the most common configuration options:
{ // Commands "repo": { "provider": "openrouter", "model": "google/gemini-2.5-pro" }, "doc": { "provider": "openrouter", "model": "anthropic/claude-sonnet-4", "maxTokens": 4096 }, "web": { "provider": "gemini", "model": "gemini-2.5-pro" }, "plan": { "fileProvider": "gemini", "thinkingProvider": "perplexity", "thinkingModel": "r1-1776" }, "browser": { "headless": false }, //... // Providers "stagehand": { "model": "claude-sonnet-4-20250514", // For Anthropic provider "provider": "anthropic", // or "openai" "timeout": 90000 }, "openai": { "model": "gpt-4o" } //... }
For details of all configuration options, see CONFIGURATION.md. This includes details of all the configuration options and how to use them.
The GitHub commands support several authentication methods:
Environment Variable: Set
GITHUB_TOKEN in your environment:
GITHUB_TOKEN=your_token_here
GitHub CLI: If you have the GitHub CLI (
gh) installed and are logged in, vibe-tools will automatically use it to generate tokens with the necessary scopes.
Git Credentials: If you have authenticated git with GitHub (via HTTPS), vibe-tools will automatically:
ghp_ or gho_)To set up git credentials:
git config --global url."https://github.com/".insteadOf [email protected]:
git config --global credential.helper store # Permanent storage # Or for macOS keychain: git config --global credential.helper osxkeychain
Authentication Status:
Without authentication:
With authentication (any method):
vibe-tools will automatically try these authentication methods in order:
GITHUB_TOKEN environment variablegh is installed and logged in)If no authentication is available, it will fall back to unauthenticated access with rate limits.
When generating documentation, vibe-tools uses Repomix to analyze your repository. By default, it excludes certain files and directories that are typically not relevant for documentation:
node_modules/, packages/, etc.)dist/, build/, etc.).git/)test/, tests/, __tests__/, etc.).env, .config, etc.)You can customize the files and folders to exclude using two methods, both can be combined together:
.repomixignore file in your project root to specify files to exclude.Example
.repomixignore file for a Laravel project:
vendor/ public/ database/ storage/ .idea .env
repomix.config.json file in your project root for more advanced configuration options:Example
repomix.config.json to enable compression and specify what to include:
{ "include": ["src/**/*", "README.md", "package.json"], "output": { "compress": true } }
This configuration will be detected and used automatically by the
repo, plan, and doc commands, allowing for precise control over which files are included in the repository analysis.
If both a .repomixignore and an ignore section in
repomix.config.json are present then the ignore patterns from both are combined.
The
browser commands support different AI models for processing from multiple providers (Anthropic, OpenAI, Gemini, OpenRouter). You can select the model using the --model option:
# Use gpt-4o vibe-tools browser act "Click Login" --url "https://example.com" --model=gpt-4o # Use Claude 4 Sonnet vibe-tools browser act "Click Login" --url "https://example.com" --model=claude-sonnet-4-20250514 # Use Gemini model vibe-tools browser act "Click Login" --url "https://example.com" --model=gemini-2.5-flash # Use OpenRouter model vibe-tools browser act "Click Login" --url "https://example.com" --model=groq-llama-3.3-70b-versatile
You can set a default provider in your
vibe-tools.config.json file under the stagehand section:
{ "stagehand": { "model": "claude-sonnet-4-20250514", // For Anthropic provider "provider": "anthropic", // "openai", "gemini", or "openrouter" "timeout": 90000 } }
You can also set a default model in your
vibe-tools.config.json file under the stagehand section:
{ "stagehand": { "provider": "openai", // "anthropic", "gemini", or "openrouter" "model": "gpt-4o" } }
If no model is specified (either on the command line or in the config), a default model will be used based on your configured provider:
anthropic/claude-sonnet-4-20250514o3-minigemini-2.5-flashgroq-llama-3.3-70b-versatileAvailable models depend on your configured provider (OpenAI or Anthropic) in
vibe-tools.config.json and your API key.
vibe-tools automatically configures Cursor by updating your project rules during installation. This provides:
For new installations, we use the recommended
.cursor/rules/vibe-tools.mdc path. For existing installations, we maintain compatibility with the legacy .cursorrules file. If both files exist, we prefer the new path and show a warning.
To get the benefits of vibe-tools you should use Cursor agent in "yolo mode". Ideal settings:
In general you do not need to use the cli directly, your AI coding agent will call the CLI but it is useful to know it exists and this is how it works.
All commands support these general options:
--model: Specify an alternative model--max-tokens: Control response length--reasoning-effort=<low|medium|high>: Control the depth of reasoning for supported models (OpenAI o1/o3-mini models, Claude 4 Sonnet, and XAI Grok models). Higher values produce more thorough responses at the cost of increased token usage.--save-to: Save command output to a file (in addition to displaying it, like tee)--quiet: Suppress stdout output (only useful with --save-to)--debug: Show detailed error information--provider: AI provider to use. Valid values: openai, anthropic, perplexity, gemini, openrouter, modelbox, xai, groq--web: Enable web search capabilities for supported models (Gemini models, XAI Grok models, Perplexity models, and ModelBox models) across all commandsDocumentation command specific options:
--from-github: Generate documentation for a remote GitHub repository (supports @branch syntax)--hint: Provide additional context or focus for documentation generation--with-doc=<doc_url>: Fetch content from one or more document URLs and include it as additional context. Can be specified multiple times.Repository command specific options:
--from-github=<GitHub username>/<repository name>[@<branch>]: Analyze a remote GitHub repository without cloning it locally--subdir=<path>: Analyze a specific subdirectory instead of the entire repository--with-doc=<doc_url>: Fetch content from one or more web URLs and include it as context. Can be specified multiple times.--with-diff: Include git diff information along with repository context for focused code review--base=<branch>: Specify base branch for diff comparison (used with --with-diff)Plan command specific options:
--fileProvider: Provider for file identification (gemini, openai, anthropic, perplexity, modelbox, or openrouter)--thinkingProvider: Provider for plan generation (gemini, openai, anthropic, perplexity, modelbox, or openrouter)--fileModel: Model to use for file identification--thinkingModel: Model to use for plan generation--fileMaxTokens: Maximum tokens for file identification--thinkingMaxTokens: Maximum tokens for plan generation--debug: Show detailed error information--with-doc=<doc_url>: Fetch content from one or more web URLs and include it as context during plan generation. Can be specified multiple times.GitHub command specific options:
--from-github=<GitHub username>/<repository name>[@<branch>]: Access PRs/issues from a specific GitHub repository. --repo is an older, still supported synonym for this option.--review-only: Show only code review comments section (PRs only)--discussion-only: Show only discussion comments section--metadata-only: Show only PR/issue metadata (labels, assignees, etc.)--no-links: Hide all "View in GitHub" links from output--hide-resolved: Filter out resolved code review comments (PRs only)Xcode command specific options:
buildPath=<path>: Set a custom derived data pathdestination=<destination string>: Set a custom simulator destinationiphone or ipad: Select device typedevice=<device name>: Specify a custom devicebuildPath=<path>: Set a custom derived data pathBrowser command specific options:
--console: Capture browser console logs (enabled by default, use --no-console to disable)--html: Capture page HTML content (disabled by default)--network: Capture network activity (enabled by default, use --no-network to disable)--screenshot: Save a screenshot of the page--timeout: Set navigation timeout (default: 120000ms for Stagehand operations, 30000ms for navigation)--viewport: Set viewport size (e.g., 1280x720)--headless: Run browser in headless mode (default: true)--no-headless: Show browser UI (non-headless mode) for debugging--connect-to: Connect to existing Chrome instance--wait: Wait after page load (e.g., 'time:5s', 'selector:#element-id')--video: Save a video recording (1280x720 resolution, timestamped subdirectory)--url: Required for act, observe, and extract commands. Url to navigate to on connection or one of the special values: 'current' (use existing page), 'reload-current' (refresh existing page).--evaluate: JavaScript code to execute in the browser before the main commandExecute commands using:
vibe-tools <command> [options]
For example:
vibe-tools web "What's new in TypeScript 5.7?"
Command Not Found
vibe-tools is installed globally using npm install -g vibe-tools/usr/local/bin or ~/.npm-global/bin%AppData%\npmInstallation Hanging in CI/CD
CI=true vibe-tools install . # or NONINTERACTIVE=true vibe-tools install .
SKIP_SETUP=true to skip API key prompts if keys are already in environmentAPI Key Errors
.vibe-tools.env exists and contains valid API keysvibe-tools install to reconfigure API keysgcloud auth application-default login and the account has appropriate permissionsgcloud auth application-default print-access-token to check if ADC is workingANTHROPIC_API_KEY or the OPENROUTER_API_KEY are set.OPENROUTER_API_KEY is set.Model Errors
GitHub API Rate Limits
GITHUB_TOKEN=your_token_here
Documentation Generation Issues
--hint to focus on specific partsCursor Integration
vibe-tools install . to update# Get information about new technologies vibe-tools web "What are the key features of Bun.js?" # Check API documentation vibe-tools web "How to implement OAuth2 in Express.js?" # Compare technologies vibe-tools web "Compare Vite vs Webpack for modern web development" # Use XAI Grok for web search with reasoning vibe-tools web "What are the latest AI safety developments?" --provider xai --reasoning-effort high
# Architecture understanding vibe-tools repo "Explain the overall architecture of this project" # Find usage examples vibe-tools repo "Show me examples of error handling in this codebase" # Debugging help vibe-tools repo "Why might the authentication be failing in the login flow?" # Analyze specific subdirectory vibe-tools repo "Explain the code structure" --subdir=src/components # Analyze remote GitHub repository vibe-tools repo "Explain the architecture" --from-github=username/repo-name # Deep analysis with enhanced reasoning vibe-tools repo "Analyze the security implications of our authentication implementation" --reasoning-effort high # Include web documentation as context vibe-tools repo "Help me implement useState in my component" --with-doc=https://react.dev/reference/react/useState or a local file path"
# Basic question vibe-tools ask "What is the capital of France?" --provider openai --model o3-mini # Complex algorithm explanation with high reasoning effort vibe-tools ask "Explain the quicksort algorithm and analyze its time complexity in different scenarios" --provider openai --model o3-mini --reasoning-effort high # Comparative analysis with Claude model and enhanced reasoning vibe-tools ask "Compare and contrast microservices vs monolithic architecture" --provider anthropic --model claude-sonnet-4-20250514 --reasoning-effort medium # Advanced reasoning with XAI Grok model vibe-tools ask "Analyze the philosophical implications of artificial general intelligence" --provider xai --model grok-4-latest --reasoning-effort high # Ask with context from multiple documents vibe-tools ask "Based on these specs, what is the main goal?" --provider openai --model o3-mini --with-doc=./specA.txt --with-doc=https://example.com/specB.txt # Ask Groq's moonshotai/kimi-k2-instruct model vibe-tools ask "Explain quantum computing" --provider groq --model moonshotai/kimi-k2-instruct # Ask Groq's qwen/qwen3-32b model vibe-tools ask "Summarize the history of AI" --provider groq --model qwen/qwen3-32b
# Document specific aspects and save to file without stdout output vibe-tools doc --save-to=docs/api.md --quiet --hint="Focus on the API endpoints and their usage" # Document with hint to customize the docs output vibe-tools doc --save-to=docs/architecture.md --quiet --hint="Focus on system architecture" # Document dependencies vibe-tools doc --from-github=expressjs/express --save-to=docs/EXPRESS.md --quiet # Document with additional web documentation as context vibe-tools doc --from-github=reactjs/react-redux --with-doc=https://redux.js.org/tutorials/fundamentals/part-5-ui-and-react --save-to=docs/REACT_REDUX.md # Document using multiple web documents as context vibe-tools doc --from-github=some/repo --with-doc=https://example.com/spec1 --with-doc=./local-spec.md --save-to=docs/MULTI_DOC.md
# List PRs with specific labels vibe-tools github pr --from-github facebook/react # Check recent issues in a specific repository vibe-tools github issue --from-github vercel/next.js # View PR with code review comments vibe-tools github pr 123 --from-github microsoft/typescript # Track issue discussions vibe-tools github issue 456 --from-github golang/go # Show only code review comments (useful for agents) vibe-tools github pr 123 --review-only # Show only discussion without code review noise vibe-tools github pr 123 --discussion-only # Get just the metadata (labels, assignees, etc.) vibe-tools github pr 123 --metadata-only # Hide GitHub links for cleaner agent output vibe-tools github pr 123 --no-links # Hide resolved code review comments, show only active discussions vibe-tools github pr 123 --review-only --hide-resolved # Combine flags for focused AI agent consumption vibe-tools github pr 123 --review-only --no-links --hide-resolved # Include web documentation as context vibe-tools repo "Help me implement useState in my component" --with-doc=./path/to/local/docs.md # Include multiple documents as context vibe-tools repo "Summarize these two specifications" --with-doc=./spec1.md --with-doc=https://example.com/spec2.pdf # Git diff integration for code review vibe-tools repo "Review my recent changes for potential issues" --with-diff # Compare changes against specific branch vibe-tools repo "Check compatibility with main branch" --with-diff --base=main # Combine diff with external documentation for comprehensive review vibe-tools repo "Does my implementation follow the API specification?" --with-diff --with-doc=./local-api-spec.md
# Set up authentication interactively vibe-tools linear connect # View specific Linear issue by identifier vibe-tools linear get-issue ITE-1850 # View issue using alternative command name vibe-tools linear issue ABC-123 # View issue by UUID (also supported) vibe-tools linear get-issue 0b906a8e-f8a8-477d-9c98-0986b09ac5f9
# Build an iOS app with default settings vibe-tools xcode build # Build with custom derived data path vibe-tools xcode build buildPath=~/custom/derived/data # Run in iPhone simulator vibe-tools xcode run iphone # Run on specific iPad model vibe-tools xcode run device="iPad Pro (12.9-inch) (6th generation)" # Analyze code quality vibe-tools xcode lint
open subcommand examples:# Open a URL and get HTML vibe-tools browser open "https://example.com" --html # Open and capture console logs and network activity vibe-tools browser open "https://example.com" --console --network # Take a screenshot vibe-tools browser open "https://example.com" --screenshot=page.png # Run in non-headless mode for debugging vibe-tools browser open "https://example.com" --no-headless
act, extract, observe subcommands examples:# AI-powered action vibe-tools browser act "Click on 'Sign Up'" --url "https://example.com" # AI-powered extraction vibe-tools browser extract "Get the main content" --url "https://example.com/blog" # AI-powered observation vibe-tools browser observe "What can I do on this page?" --url "https://example.com"
# Generate a comprehensive summary of a technical talk vibe-tools youtube "https://www.youtube.com/watch?v=dQw4w9WgXcQ" --type=summary # Get a complete transcript with speaker annotations vibe-tools youtube "https://www.youtube.com/watch?v=dQw4w9WgXcQ" --type=transcript --save-to=transcript.md # Create an implementation plan from a coding tutorial vibe-tools youtube "https://www.youtube.com/watch?v=dQw4w9WgXcQ" --type=plan # Generate a critical review of a tutorial's accuracy and quality vibe-tools youtube "https://www.youtube.com/watch?v=dQw4w9WgXcQ" --type=review # Ask specific questions about video content vibe-tools youtube "https://www.youtube.com/watch?v=dQw4w9WgXcQ" "What libraries does the tutorial use for authentication?" # Use a specific model for analysis vibe-tools youtube "https://www.youtube.com/watch?v=dQw4w9WgXcQ" --model=gemini-2.5-pro # Use custom analysis type for specialized insights vibe-tools youtube "https://www.youtube.com/watch?v=dQw4w9WgXcQ" --type=custom "Extract all code examples and explain them in detail"
vibe-tools is available on npm here
Contributions are welcome! Please feel free to submit a Pull Request. If you used vibe-tools to make your contribution please include screenshots or videos of vibe-tools in action.
Optimise your Vinted accounting with real-time analytics, inventory management, and tax compliance tools.
🔗 Start scaling your Vinted business today
Automate your Vinted reselling business with advanced tools like autobuy, custom snipers, and one-click relisting.
🔗 Take Vinted reselling to the next level
Build self-driving startups with autonomous AI agents that run your company.
🔗 AI Engineer in London? Join the startup revolution
MIT License - see LICENSE for details.