| Summary | Prompt it |
|---------|-----------|
| Essential information to understand what vibe-tools is and how to get started using it | [](https://lmpify.com?q=https%3A%2F%2Fuuithub.com%2Feastlondoner%2Fcursor-tools%2Ftree%2Fmain%3FpathPatterns%3DREADME.md%26pathPatterns%3DCONFIGURATION.md%26pathPatterns%3Dpackage.json%26pathPatterns%3Dvibe-tools.config.json%26pathPatterns%3D.cursor-tools.env.example%26pathPatterns%3Dsrc%252Fvibe-rules.ts%0A%0AI'm%20new%20to%20vibe-tools.%20Can%20you%20explain%20what%20it%20is%2C%20how%20to%20install%20it%2C%20and%20how%20to%20get%20started%20with%20basic%20commands%3F) |
| Overview of available commands and their basic functionality | [](https://lmpify.com?q=https%3A%2F%2Fuuithub.com%2Feastlondoner%2Fcursor-tools%2Ftree%2Fmain%3FpathPatterns%3Dsrc%252Fcommands%252Findex.ts%26pathPatterns%3Dsrc%252Ftypes.ts%26pathPatterns%3Dsrc%252Fvibe-rules.ts%26pathPatterns%3DREADME.md%0A%0AWhat%20commands%20are%20available%20in%20vibe-tools%20and%20what%20does%20each%20one%20do%3F) |
| Browser automation commands and capabilities | [](https://lmpify.com?q=https%3A%2F%2Fuuithub.com%2Feastlondoner%2Fcursor-tools%2Ftree%2Fmain%3FpathPatterns%3Dsrc%252Fcommands%252Fbrowser%252F**%252F*.ts%26pathPatterns%3Dtests%252Fcommands%252Fbrowser%252F*.html%26excludePathPatterns%3Dsrc%252Fcommands%252Fbrowser%252Fstagehand%252FstagehandScript.ts%0A%0AHow%20do%20I%20use%20the%20browser%20commands%20in%20vibe-tools%3F%20What%20browser%20automation%20capabilities%20are%20available%3F) |
| LLM provider integration and configuration | [](https://lmpify.com?q=https%3A%2F%2Fuuithub.com%2Feastlondoner%2Fcursor-tools%2Ftree%2Fmain%3FpathPatterns%3Dsrc%252Futils%252Ftool-enabled-llm%252F**%26pathPatterns%3Dsrc%252Fproviders%252F**%26pathPatterns%3Dsrc%252Fllms%252F**%26pathPatterns%3D.cursor-tools.env.example%0A%0AHow%20do%20I%20configure%20different%20LLM%20providers%20with%20vibe-tools%3F%20What%20providers%20are%20supported%3F) |
| Model Context Protocol (MCP) commands and tools | [](https://lmpify.com?q=https%3A%2F%2Fuuithub.com%2Feastlondoner%2Fcursor-tools%2Ftree%2Fmain%3FpathPatterns%3Dsrc%252Fcommands%252Fmcp%252F**%252F*.ts%0A%0AHow%20do%20I%20use%20the%20MCP%20commands%20in%20vibe-tools%3F%20What%20is%20MCP%20and%20how%20does%20it%20work%3F) |
| Testing framework and capabilities | [](https://lmpify.com?q=https%3A%2F%2Fuuithub.com%2Feastlondoner%2Fcursor-tools%2Ftree%2Fmain%3FpathPatterns%3Dsrc%252Fcommands%252Ftest%252F**%252F*.ts%26pathPatterns%3Dtests%252Ffeature-behaviors%252F**%252F*.md%26pathPatterns%3DTESTING.md%0A%0AHow%20do%20I%20use%20the%20testing%20capabilities%20in%20vibe-tools%3F%20How%20can%20I%20create%20and%20run%20tests%3F) |
| Configuration options and customization | [](https://lmpify.com?q=https%3A%2F%2Fuuithub.com%2Feastlondoner%2Fcursor-tools%2Ftree%2Fmain%3FpathPatterns%3Dsrc%252Fconfig.ts%26pathPatterns%3Dvibe-tools.config.json%26pathPatterns%3D.cursor-tools.env.example%26pathPatterns%3DCONFIGURATION.md%26pathPatterns%3Dsrc%252Fvibe-rules.ts%0A%0AHow%20do%20I%20configure%20vibe-tools%3F%20What%20configuration%20options%20are%20available%3F) |
| Telemetry implementation and infrastructure | [](https://lmpify.com?q=https%3A%2F%2Fuuithub.com%2Feastlondoner%2Fcursor-tools%2Ftree%2Fmain%3FpathPatterns%3Dsrc%252Ftelemetry%252F**%26pathPatterns%3Dinfra%252F**%26pathPatterns%3DTELEMETRY.md%0A%0AHow%20does%20telemetry%20work%20in%20vibe-tools%3F%20What%20data%20is%20collected%20and%20how%20is%20it%20used%3F) |
| Example usage | [](https://lmpify.com?q=https%3A%2F%2Fuuithub.com%2Feastlondoner%2Fcursor-tools%2Ftree%2Fmain%3FpathPatterns%3Dsrc%252Fvibe-rules.ts%26pathPatterns%3DREADME.md%26pathPatterns%3DCONFIGURATION.md%0A%0ACan%20you%20show%20me%20some%20examples%20of%20how%20to%20use%20vibe-tools%20commands%20effectively%3F) |
## Table of Contents
- [The AI Team](#the-ai-team)
- [New Skills](#new-skills-for-your-existing-agent)
- [How to Use](#how-do-i-use-it)
- [Example: Using Perplexity](#asking-perplexity-to-carry-out-web-research)
- [Example: Using Gemini](#asking-gemini-for-a-plan)
- [What is vibe-tools](#what-is-vibe-tools)
- [Installation](#installation)
- [Requirements](#requirements)
- [Telemetry & Privacy](#telemetry--privacy)
- [Tips](#tips)
- [Additional Examples](#additional-examples)
- [GitHub Skills](#github-skills)
- [Gemini Code Review](#gemini-code-review)
- [Detailed Cursor Usage](#detailed-cursor-usage)
- [Tool Recommendations](#tool-recommendations)
- [Command Nicknames](#command-nicknames)
- [Web Search](#use-web-search)
- [Repository Search](#use-repo-search)
- [Documentation Generation](#use-doc-generation)
- [GitHub Integration](#use-github-integration)
- [Browser Automation](#use-browser-automation)
- [Direct Model Queries](#use-direct-model-queries)
- [Authentication and API Keys](#authentication-and-api-keys)
- [AI Team Features](#ai-team-features)
- [Perplexity: Web Search & Research](#perplexity-web-search--research)
- [Gemini 2.0: Repository Context & Planning](#gemini-20-repository-context--planning)
- [Stagehand: Browser Automation](#stagehand-browser-automation)
- [Browser Command Options](#browser-command-options)
- [Video Recording](#video-recording)
- [Console and Network Logging](#console-and-network-logging)
- [Complex Actions](#complex-actions)
- [Troubleshooting Browser Commands](#troubleshooting-browser-commands)
- [YouTube Video Analysis](#youtube-video-analysis)
- [Skills](#skills)
- [GitHub Integration](#github-integration)
- [Linear Integration](#linear-integration)
- [Xcode Tools](#xcode-tools)
- [Documentation Generation](#documentation-generation-uses-gemini-20)
- [Wait Command](#wait-command)
- [Configuration](#configuration)
- [vibe-tools.config.json](#vibe-toolsconfigjson)
- [GitHub Authentication](#github-authentication)
- [Repomix Configuration](#repomix-configuration)
- [Model Selection](#model-selection)
- [Cursor Configuration](#cursor-configuration)
- [Cursor Agent Configuration](#cursor-agent-configuration)
- [vibe-tools cli](#vibe-tools-cli)
- [Command Options](#command-options)
- [Execution Methods](#execution-methods)
- [Troubleshooting](#troubleshooting)
- [Examples](#examples)
- [Web Search Examples](#web-search-examples)
- [Repository Context Examples](#repository-context-examples)
- [Documentation Examples](#documentation-examples)
- [GitHub Integration Examples](#github-integration-examples)
- [Xcode Command Examples](#xcode-command-examples)
- [Browser Command Examples](#browser-command-examples)
- [open subcommand examples](#open-subcommand-examples)
- [act, extract, observe subcommands examples](#act-extract-observe-subcommands-examples)
- [YouTube Command Examples](#youtube-command-examples)
- [Node Package Manager](#node-package-manager-npm)
- [Contributing](#contributing)
- [Sponsors](#sponsors)
- [License](#license)
### The AI Team
- Perplexity to search the web and perform deep research
- Gemini 2.0 for huge whole-codebase context window, search grounding and reasoning
- Stagehand for browser operation to test and debug web apps (uses Anthropic, OpenAI, Gemini, or OpenRouter models)
- OpenRouter for access to a variety of models through a unified API (for MCP commands)
### New Skills for your existing Agent
- Work with GitHub Issues and Pull Requests
- Access Linear issues with full context and comments
- Generate local agent-accessible documentation for external dependencies
- Analyze YouTube videos to extract insights, summaries, and implementation plans
`vibe-tools` is optimized for Cursor Composer Agent but it can be used by any coding agent that can execute commands
### How do I use it?
After installation, to see AI teamwork in action just ask Cursor Composer to use Perplexity or Gemini.
Here are two examples:
see what happens next...
see what happens next...
see what happens next...
see the spec composer and perplexity produced together:
pac-man-spec.md (link out to the example repo)
see what happens next...
see what happens next...
see what happens next...
see the spec composer and perplexity produced together:
pac-man-plan.md (link out to the example repo)
## What is vibe-tools
`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:
- **Supported IDEs/Environments**: Cursor, Claude Code, Codex, Windsurf, Cline, Roo.
- **Instruction File Setup**: The installer automatically creates or updates relevant configuration files:
- For **Cursor**: `.cursorrules` or `.cursor/rules/vibe-tools.mdc`.
- For **Claude Code**: `CLAUDE.md` (local or global `~/.claude/CLAUDE.md`).
- For **Codex**: `codex.md` (local or global `~/.codex/instructions.md`).
- For **Windsurf**: `.windsurfrules`.
- For **Cline/Roo**: `.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.
## Installation
Install vibe-tools globally:
```bash
npm install -g vibe-tools
```
Then run the setup:
```bash
vibe-tools install .
```
This command will:
1. Guide you through API key configuration for the AI providers you choose.
2. Automatically install Playwright browsers (Chromium) for browser automation commands.
3. Create or update AI instruction files based on your selected IDE (e.g., setting up `.cursorrules` for Cursor, `CLAUDE.md` for Claude Code, `.windsurfrules` for Windsurf, etc.).
### Non-Interactive Installation (CI/CD)
For automated environments, `vibe-tools install` automatically detects CI environments and runs in non-interactive mode:
```bash
# 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:
- Auto-detect your package manager and IDE environment
- Use existing configurations (local takes precedence over global)
- Apply sensible defaults for new installations
- Skip writing API keys to files (uses environment variables only)
- Enable telemetry by default (can be disabled with `VIBE_TOOLS_NO_TELEMETRY=1`)
## Requirements
- Node.js 18 or later
- Perplexity API key
- Google Gemini API key
- For browser commands:
- Playwright browsers are automatically installed during `vibe-tools install`
- OpenAI API key or Anthropic API key (for `act`, `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