Windsurf rules

1This is the vibe-tools repo. Here we build a cli tool that AI agents can use to execute commands and work with other AI agents.
2 
3This repo uses pnpm as the package manager and script runner.
4 
5use pnpm dev <command> to run dev commands.
6 
7We add AI "teammates" as commands that can be asked questions.
8We add "skills" as commands that can be used to execute tasks.
9 
10Everything is implemented as a cli command that must return a result (cannot be a long running process).
11 
12The released commands are documented below. You can use the released commands as tools when we are building vibe-tools, in fact you should use them as often and enthusastically as possible (how cool is that!)
13 
14Don't ask me for permission to do stuff - if you have questions work with Gemini and Perplexity to decide what to do: they're your teammates. You're a team of superhuman expert AIs, believe in yourselves! Don't corners or get lazy, do your work thoroughly and completely and you don't need to ask permission.
15 
16We do not do automated unit tests or integration tests - it's trivial to manually test all the commmands by just asking cursor agent to read the readme and test all the commands.
17 
18do not install commander
19 
20<logging and outputs>
21There are three ways that we communicate to the caller.
22console.log which goes to stdout
23console.error which goes to stderr
24do not use console.debug or console.warn or console.info
25and yield which is streamed either to stdout (unless the --quiet flag is used) and to the file specified by --save-to (if --save-to is specified).
26 
27console.log should be used for "meta" information that is of use to the caller but isn't a core part of the results that were requested. E.g. recording which model is being used to perfom an action.
28 
29console.error should be used for error messages.
30 
31yield should be used for the output of the command that contains the information that was requested. d
32</logging and outputs>
33 
34<testing browser commands>
35There is a test server for browser command testing and a collection of test files in tests/commands/browser/
36 
37Usage:
381. Run with: pnpm serve-test
392. Server starts at http://localhost:3000
403. Place test HTML files in tests/commands/browser/
414. Access files at http://localhost:3000/filename.html
42 
43remember that this will be a long running process that does not exit so you should run it in a separate background terminal.
44 
45If it won't start because the port is busy run `lsof -i :3000 | grep LISTEN | awk '{print $2}' | xargs kill` to kill the process and free the port.
46 
47to run test commands with latest code use `pnpm dev browser <commands>`
48 
49For interactive debugging start chrome in debug mode using:
50```
51open -a "Google Chrome" --args --remote-debugging-port=9222 --no-first-run --no-default-browser-check --user-data-dir="/tmp/chrome-remote-debugging"
52```
53note: this command will exit as soon as chrome is open so you can just execute it, it doesn't need to be run in a background task.
54</testing browser commands>
55 
56vibe-tools is a CLI tool that allows you to interact with AI models and other tools.
57vibe-tools is installed on this machine and it is available to you to execute. You're encouraged to use it.
58 
59<vibe-tools Integration>
60# Instructions
61Use the following commands to get AI assistance:
62 
63**Direct Model Queries:**
64`vibe-tools ask "<your question>" --provider <provider> --model <model>` - Ask any model from any provider a direct question (e.g., `vibe-tools ask "What is the capital of France?" --provider openai --model o3-mini`). Note that 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. In general you should not use the ask command because it does not include any context. The other commands like `web`, `doc`, `repo`, or `plan` are usually better. If you are using it, make sure to include in your question all the information and context that the model might need to answer usefully.
65 
66**Ask Command Options:**
67--provider=<provider>: AI provider to use (openai, anthropic, perplexity, gemini, modelbox, openrouter, or xai)
68--model=<model>: Model to use (required for the ask command)
69--reasoning-effort=<low|medium|high>: Control the depth of reasoning for supported models (OpenAI o1/o3-mini models and Claude 3.7 Sonnet). Higher values produce more thorough responses for complex questions.
70 
71**Implementation Planning:**
72`vibe-tools plan "<query>"` - Generate a focused implementation plan using AI (e.g., `vibe-tools plan "Add user authentication to the login page"`)
73The plan command uses multiple AI models to:
741. Identify relevant files in your codebase (using Gemini by default)
752. Extract content from those files
763. Generate a detailed implementation plan (using OpenAI o3-mini by default)
77 
78**Plan Command Options:**
79--fileProvider=<provider>: Provider for file identification (gemini, openai, anthropic, perplexity, modelbox, openrouter, or xai)
80--thinkingProvider=<provider>: Provider for plan generation (gemini, openai, anthropic, perplexity, modelbox, openrouter, or xai)
81--fileModel=<model>: Model to use for file identification
82--thinkingModel=<model>: Model to use for plan generation
83--with-doc=<doc_url>: Fetch content from a document URL and include it as context for both file identification and planning (e.g., `vibe-tools plan "implement feature X following the spec" --with-doc=https://example.com/feature-spec`)
84 
85**Web Search:**
86`vibe-tools web "<your question>"` - Get answers from the web using a provider that supports web search (e.g., Perplexity models and Gemini Models either directly or from OpenRouter or ModelBox) (e.g., `vibe-tools web "latest shadcn/ui installation instructions"`)
87Note: web is a smart autonomous agent with access to the internet and an extensive up to date knowledge base. Web is NOT a web search engine. Always ask the agent for what you want using a proper sentence, do not just send it a list of keywords. In your question to web include the context and the goal that you're trying to acheive so that it can help you most effectively.
88when using web for complex queries suggest writing the output to a file somewhere like local-research/<query summary>.md.
89 
90**Web Command Options:**
91--provider=<provider>: AI provider to use (perplexity, gemini, modelbox, or openrouter)
92 
93**Repository Context:**
94`vibe-tools repo "<your question>" [--subdir=<path>] [--from-github=<username/repo>] [--with-doc=<doc_url>]` - Get context-aware answers about this repository using Google Gemini (e.g., `vibe-tools repo "explain authentication flow"`). Use the optional `--subdir` parameter to analyze a specific subdirectory instead of the entire repository (e.g., `vibe-tools repo "explain the code structure" --subdir=src/components`). Use the optional `--from-github` parameter to analyze a remote GitHub repository without cloning it locally (e.g., `vibe-tools repo "explain the authentication system" --from-github=username/repo-name`). Use the optional `--with-doc` parameter to include content from a URL as additional context (e.g., `vibe-tools repo "implement feature X following the design spec" --with-doc=https://example.com/design-spec`).
95 
96**Documentation Generation:**
97`vibe-tools doc [options] [--with-doc=<doc_url>]` - Generate comprehensive documentation for this repository (e.g., `vibe-tools doc --output docs.md`). Can incorporate document context from a URL (e.g., `vibe-tools doc --with-doc=https://example.com/existing-docs`).
98 
99**YouTube Video Analysis:**
100`vibe-tools youtube "<youtube-url>" [question] [--type=<summary|transcript|plan|review|custom>]` - Analyze YouTube videos and generate detailed reports (e.g., `vibe-tools youtube "https://youtu.be/43c-Sm5GMbc" --type=summary`)
101Note: The YouTube command requires a `GEMINI_API_KEY` to be set in your environment or .vibe-tools.env file as the GEMINI API is the only interface that supports YouTube analysis.
102 
103**GitHub Information:**
104`vibe-tools github pr [number]` - Get the last 10 PRs, or a specific PR by number (e.g., `vibe-tools github pr 123`)
105`vibe-tools github issue [number]` - Get the last 10 issues, or a specific issue by number (e.g., `vibe-tools github issue 456`)
106 
107**ClickUp Information:**
108`vibe-tools clickup task <task_id>` - Get detailed information about a ClickUp task including description, comments, status, assignees, and metadata (e.g., `vibe-tools clickup task "task_id"`)
109 
110**Model Context Protocol (MCP) Commands:**
111Use the following commands to interact with MCP servers and their specialized tools:
112`vibe-tools mcp search "<query>"` - Search the MCP Marketplace for available servers that match your needs (e.g., `vibe-tools mcp search "git repository management"`)
113`vibe-tools mcp run "<query>"` - Execute MCP server tools using natural language queries (e.g., `vibe-tools mcp run "list files in the current directory" --provider=openrouter`). The query must include sufficient information for vibe-tools to determine which server to use, provide plenty of context.
114 
115The `search` command helps you discover servers in the MCP Marketplace based on their capabilities and your requirements. The `run` command automatically selects and executes appropriate tools from these servers based on your natural language queries. If you want to use a specific server include the server name in your query. E.g. `vibe-tools mcp run "using the mcp-server-sqlite list files in directory --provider=openrouter"`
116 
117**Notes on MCP Commands:**
118- MCP commands require `ANTHROPIC_API_KEY` or `OPENROUTER_API_KEY` to be set in your environment
119- By default the `mcp` command uses Anthropic, but takes a --provider argument that can be set to 'anthropic' or 'openrouter'
120- Results are streamed in real-time for immediate feedback
121- Tool calls are automatically cached to prevent redundant operations
122- Often the MCP server will not be able to run because environment variables are not set. If this happens ask the user to add the missing environment variables to the cursor tools env file at ~/.vibe-tools/.env
123 
124**Stagehand Browser Automation:**
125`vibe-tools browser open <url> [options]` - Open a URL and capture page content, console logs, and network activity (e.g., `vibe-tools browser open "https://example.com" --html`)
126`vibe-tools browser act "<instruction>" --url=<url | 'current'> [options]` - Execute actions on a webpage using natural language instructions (e.g., `vibe-tools browser act "Click Login" --url=https://example.com`)
127`vibe-tools browser observe "<instruction>" --url=<url> [options]` - Observe interactive elements on a webpage and suggest possible actions (e.g., `vibe-tools browser observe "interactive elements" --url=https://example.com`)
128`vibe-tools browser extract "<instruction>" --url=<url> [options]` - Extract data from a webpage based on natural language instructions (e.g., `vibe-tools browser extract "product names" --url=https://example.com/products`)
129 
130**Notes on Browser Commands:**
131- All browser commands are stateless unless --connect-to is used to connect to a long-lived interactive session. In disconnected mode each command starts with a fresh browser instance and closes it when done.
132- When using `--connect-to`, special URL values are supported:
133  - `current`: Use the existing page without reloading
134  - `reload-current`: Use the existing page and refresh it (useful in development)
135  - If working interactively with a user you should always use --url=current unless you specifically want to navigate to a different page. Setting the url to anything else will cause a page refresh loosing current state.
136- Multi step workflows involving state or combining multiple actions are supported in the `act` command using the pipe (|) separator (e.g., `vibe-tools browser act "Click Login | Type 'user@example.com' into email | Click Submit" --url=https://example.com`)
137- Video recording is available for all browser commands using the `--video=<directory>` option. This will save a video of the entire browser interaction at 1280x720 resolution. The video file will be saved in the specified directory with a timestamp.
138- DO NOT ask browser act to "wait" for anything, the wait command is currently disabled in Stagehand.
139 
140**Tool Recommendations:**
141- `vibe-tools web` is best for general web information not specific to the repository. Generally call this without additional arguments.
142- `vibe-tools repo` is ideal for repository-specific questions, planning, code review and debugging. E.g. `vibe-tools repo "Review recent changes to command error handling looking for mistakes, omissions and improvements"`. Generally call this without additional arguments.
143- `vibe-tools plan` is ideal for planning tasks. E.g. `vibe-tools plan "Adding authentication with social login using Google and Github"`. Generally call this without additional arguments.
144- `vibe-tools doc` generates documentation for local or remote repositories.
145- `vibe-tools youtube` analyzes YouTube videos to generate summaries, transcripts, implementation plans, or custom analyses
146- `vibe-tools browser` is useful for testing and debugging web apps and uses Stagehand
147- `vibe-tools mcp` enables interaction with specialized tools through MCP servers (e.g., for Git operations, file system tasks, or custom tools)
148 
149**Running Commands:**
1501. Use `vibe-tools <command>` to execute commands (make sure vibe-tools is installed globally using npm install -g vibe-tools so that it is in your PATH)
151 
152**General Command Options (Supported by all commands):**
153--provider=<provider>: AI provider to use (openai, anthropic, perplexity, gemini, openrouter, modelbox, or xai). If provider is not specified, the default provider for that task will be used.
154--model=<model name>: Specify an alternative AI model to use. If model is not specified, the provider's default model for that task will be used.
155--max-tokens=<number>: Control response length
156--save-to=<file path>: Save command output to a file (in *addition* to displaying it)
157--help: View all available options (help is not fully implemented yet)
158--debug: Show detailed logs and error information
159 
160**Repository Command Options:**
161--provider=<provider>: AI provider to use (gemini, openai, openrouter, perplexity, modelbox, anthropic, or xai)
162--model=<model>: Model to use for repository analysis
163--max-tokens=<number>: Maximum tokens for response
164--from-github=<GitHub username>/<repository name>[@<branch>]: Analyze a remote GitHub repository without cloning it locally
165--subdir=<path>: Analyze a specific subdirectory instead of the entire repository
166--with-doc=<doc_url>: Fetch content from a document URL and include it as context
167 
168**Documentation Command Options:**
169--from-github=<GitHub username>/<repository name>[@<branch>]: Generate documentation for a remote GitHub repository
170--provider=<provider>: AI provider to use (gemini, openai, openrouter, perplexity, modelbox, anthropic, or xai)
171--model=<model>: Model to use for documentation generation
172--max-tokens=<number>: Maximum tokens for response
173--with-doc=<doc_url>: Fetch content from a document URL and include it as context
174 
175**YouTube Command Options:**
176--type=<summary|transcript|plan|review|custom>: Type of analysis to perform (default: summary)
177 
178**GitHub Command Options:**
179--from-github=<GitHub username>/<repository name>[@<branch>]: Access PRs/issues from a specific GitHub repository
180 
181**Browser Command Options (for 'open', 'act', 'observe', 'extract'):**
182--console: Capture browser console logs (enabled by default, use --no-console to disable)
183--html: Capture page HTML content (disabled by default)
184--network: Capture network activity (enabled by default, use --no-network to disable)
185--screenshot=<file path>: Save a screenshot of the page
186--timeout=<milliseconds>: Set navigation timeout (default: 120000ms for Stagehand operations, 30000ms for navigation)
187--viewport=<width>x<height>: Set viewport size (e.g., 1280x720). When using --connect-to, viewport is only changed if this option is explicitly provided
188--headless: Run browser in headless mode (default: true)
189--no-headless: Show browser UI (non-headless mode) for debugging
190--connect-to=<port>: Connect to existing Chrome instance. Special values: 'current' (use existing page), 'reload-current' (refresh existing page)
191--wait=<time:duration or selector:css-selector>: Wait after page load (e.g., 'time:5s', 'selector:#element-id')
192--video=<directory>: Save a video recording (1280x720 resolution, timestamped subdirectory). Not available when using --connect-to
193--url=<url>: Required for `act`, `observe`, and `extract` commands. Url to navigate to before the main command or one of the special values 'current' (to stay on the current page without navigating or reloading) or 'reload-current' (to reload the current page)
194--evaluate=<string>: JavaScript code to execute in the browser before the main command
195 
196**Nicknames**
197Users can ask for these tools using nicknames
198Gemini is a nickname for vibe-tools repo
199Perplexity is a nickname for vibe-tools web
200Stagehand is a nickname for vibe-tools browser
201If people say "ask Gemini" or "ask Perplexity" or "ask Stagehand" they mean to use the `vibe-tools` command with the `repo`, `web`, or `browser` commands respectively.
202 
203**Xcode Commands:**
204`vibe-tools xcode build [buildPath=<path>] [destination=<destination>]` - Build Xcode project and report errors.
205**Build Command Options:**
206--buildPath=<path>: (Optional) Specifies a custom directory for derived build data. Defaults to ./.build/DerivedData.
207--destination=<destination>: (Optional) Specifies the destination for building the app (e.g., 'platform=iOS Simulator,name=iPhone 16 Pro'). Defaults to 'platform=iOS Simulator,name=iPhone 16 Pro'.
208 
209`vibe-tools xcode run [destination=<destination>]` - Build and run the Xcode project on a simulator.
210**Run Command Options:**
211--destination=<destination>: (Optional) Specifies the destination simulator (e.g., 'platform=iOS Simulator,name=iPhone 16 Pro'). Defaults to 'platform=iOS Simulator,name=iPhone 16 Pro'.
212 
213`vibe-tools xcode lint` - Run static analysis on the Xcode project to find and fix issues.
214 
215**Additional Notes:**
216- For detailed information, see `node_modules/vibe-tools/README.md` (if installed locally).
217- Configuration is in `vibe-tools.config.json` (or `~/.vibe-tools/config.json`).
218- API keys are loaded from `.vibe-tools.env` (or `~/.vibe-tools/.env`).
219- ClickUp commands require a `CLICKUP_API_TOKEN` to be set in your `.vibe-tools.env` file.
220- Available models depend on your configured provider (OpenAI, Anthropic, xAI, etc.) in `vibe-tools.config.json`.
221- repo has a limit of 2M tokens of context. The context can be reduced by filtering out files in a .repomixignore file.
222- problems running browser commands may be because playwright is not installed. Recommend installing playwright globally.
223- MCP commands require `ANTHROPIC_API_KEY` or `OPENROUTER_API_KEY`
224- **Remember:** You're part of a team of superhuman expert AIs. Work together to solve complex problems.
225- **Repomix Configuration:** You can customize which files are included/excluded during repository analysis by creating a `repomix.config.json` file in your project root. This file will be automatically detected by `repo`, `plan`, and `doc` commands.
226 
227<!-- vibe-tools-version: 0.60.6 -->
228</vibe-tools Integration>
229