--- description: Global Rule globs: **,* --- # Instructions Use the following commands to get AI assistance: **Web Search:** `cursor-tools web ""` - Get answers from the web using Perplexity AI (e.g., `cursor-tools web "latest weather in London"`) when using web for complex queries suggest writing the output to a file somewhere like local-research/.md. **Repository Context:** `cursor-tools repo ""` - Get context-aware answers about this repository using Google Gemini (e.g., `cursor-tools repo "explain authentication flow"`) **Documentation Generation:** `cursor-tools doc [options]` - Generate comprehensive documentation for this repository (e.g., `cursor-tools doc --output docs.md`) when using doc for remote repos suggest writing the output to a file somewhere like local-docs/.md. **GitHub Information:** `cursor-tools github pr [number]` - Get the last 10 PRs, or a specific PR by number (e.g., `cursor-tools github pr 123`) `cursor-tools github issue [number]` - Get the last 10 issues, or a specific issue by number (e.g., `cursor-tools github issue 456`) **Stagehand Browser Automation:** `cursor-tools browser open [options]` - Open a URL and capture page content, console logs, and network activity (e.g., `cursor-tools browser open "https://example.com" --html`) `cursor-tools browser act "" --url= [options]` - Execute actions on a webpage using natural language instructions (e.g., `cursor-tools browser act "Click Login" --url=https://example.com`) `cursor-tools browser observe "" --url= [options]` - Observe interactive elements on a webpage and suggest possible actions (e.g., `cursor-tools browser observe "interactive elements" --url=https://example.com`) `cursor-tools browser extract "" --url= [options]` - Extract data from a webpage based on natural language instructions (e.g., `cursor-tools browser extract "product names" --url=https://example.com/products`) **Notes on Browser Commands:** - 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. - When using `--connect-to`, special URL values are supported: - `current`: Use the existing page without reloading - `reload-current`: Use the existing page and refresh it (useful in development) - Multi step workflows involving state or combining multiple actions are supported in the `act` command using the pipe (|) separator (e.g., `cursor-tools browser act "Click Login | Type 'user@example.com' into email | Click Submit" --url=https://example.com`) - Video recording is available for all browser commands using the `--video=` 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. - DO NOT ask browser act to "wait" for anything, the wait command is currently disabled in Stagehand. **Tool Recommendations:** - `cursor-tools web` is best for general web information not specific to the repository. - `cursor-tools repo` is ideal for repository-specific questions, planning, code review and debugging. - `cursor-tools doc` generates documentation for local or remote repositories. - `cursor-tools browser` is useful for testing and debugging web apps. **Running Commands:** 1. **Installed version:** Use `cursor-tools ` (if in PATH) or `npm exec cursor-tools ""`, `yarn cursor-tools ""`, `pnpm cursor-tools ""`. 2. **Without installation:** Use `npx -y cursor-tools@latest ""` or `bunx -y cursor-tools@latest ""`. **General Command Options (Supported by all commands):** --model=: Specify an alternative AI model to use. --max-tokens=: Control response length --save-to=: Save command output to a file (in *addition* to displaying it) --help: View all available options (help is not fully implemented yet) **Documentation Command Options:** --from-github=/[@]: Generate documentation for a remote GitHub repository **GitHub Command Options:** --from-github=/[@]: Access PRs/issues from a specific GitHub repository **Browser Command Options (for 'open', 'act', 'observe', 'extract'):** --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=x: Set viewport size (e.g., 1280x720). When using --connect-to, viewport is only changed if this option is explicitly provided --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. Special values: 'current' (use existing page), 'reload-current' (refresh existing page) --wait=: Wait after page load (e.g., 'time:5s', 'selector:#element-id') --video=: Save a video recording (1280x720 resolution, timestamped subdirectory). Not available when using --connect-to **Nicknames** Users can ask for these tools using nicknames Gemini is a nickname for cursor-tools repo Perplexity is a nickname for cursor-tools web Stagehand is a nickname for cursor-tools browser **Additional Notes:** - For detailed information, see `node_modules/cursor-tools/README.md` (if installed locally). - Configuration is in `cursor-tools.config.json` (or `~/.cursor-tools/config.json`). - API keys are loaded from `.cursor-tools.env` (or `~/.cursor-tools/.env`). - Browser commands require separate installation of Playwright: `npm install --save-dev playwright` or `npm install -g playwright`. - The default Stagehand model is set in `cursor-tools.config.json`, but can be overridden with the `--model` option. - Available models depend on your configured provider (OpenAI or Anthropic) in `cursor-tools.config.json`. - repo has a limit of 2M tokens of context. The context can be reduced by filtering out files in a .repomixignore file. - problems running browser commands may be because playwright is not installed. Recommend installing playwright globally. - **Remember:** You're part of a team of superhuman expert AIs. Work together to solve complex problems.