> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

## Prerequisites

* An BugRadar account ([sign up](https://usebugradar.com/signup))
* A mobile app or website that you want to test (duh)

## When You Sign Up

A short setup walks you through it: name your workspace, then let your coding agent set things up or do it yourself and run your first flow.

Afterwards, the **Get started** card on your [home page](https://usebugradar.com/overview) shows what's left. Click **Restart setup** on that card to go through it again.

## Getting Started

> [tab] Automated (Recommended)
>
> ### 1. Add the MCP Server
>
> Connect BugRadar with your existing account using browser sign-in. Devin currently uses the API-key setup described below.
>
> > [tab] Claude Code
> >
> > If you added BugRadar from the [Claude connector directory](https://claude.ai/directory/BugRadar) and sign in to Claude Code with your Claude account, it already appears in `/mcp`.
> >
> > Otherwise, run in your project directory:
> >
> > ```bash theme={null}
> > claude mcp add --transport http BugRadar https://mcp.usebugradar.com/mcp
> > ```
> >
> > Open Claude Code, run `/mcp`, select BugRadar, and follow the browser sign-in prompt.
>
> > [tab] Claude Desktop
> >
> > Open [BugRadar in the Claude connector directory](https://claude.ai/directory/BugRadar), choose **Connect**, and sign in through your browser.
> >
> > Or add it manually: in Claude, open **Customize → Connectors → Add custom connector**. Enter **BugRadar** as the name and this server URL:
> >
> > ```text theme={null}
> > https://mcp.usebugradar.com/mcp
> > ```
> >
> > Choose **Connect** and sign in through your browser. Your Claude account must support custom connectors; if the option is disabled, ask your workspace administrator or use another supported client.
>
> > [tab] Cursor
> >
> > Add BugRadar to `~/.cursor/mcp.json`, preserving any existing servers:
> >
> > ```json theme={null}
> > {
> >   "mcpServers": {
> >     "BugRadar": {
> >       "url": "https://mcp.usebugradar.com/mcp"
> >     }
> >   }
> > }
> > ```
> >
> > Open Cursor's MCP settings and click **Authenticate** beside BugRadar.
>
> > [tab] Gemini CLI
> >
> > Run:
> >
> > ```bash theme={null}
> > gemini mcp add --transport http BugRadar https://mcp.usebugradar.com/mcp
> > ```
> >
> > In Gemini CLI, run `/mcp auth BugRadar` and follow the browser sign-in prompt.
>
> > [tab] Codex
> >
> > Run:
> >
> > ```bash theme={null}
> > codex mcp add BugRadar --url https://mcp.usebugradar.com/mcp
> > codex mcp login BugRadar
> > ```
> >
> > If you configure Codex manually, add the following to `~/.codex/config.toml`, then run `codex mcp login BugRadar`:
> >
> > ```toml theme={null}
> > [mcp_servers.BugRadar]
> > url = "https://mcp.usebugradar.com/mcp"
> > ```
>
> > [tab] Dots
> >
> > A dot uses plugins installed in ChatGPT. In ChatGPT on the web, open **Settings → Security and login** and turn on **Developer mode** (Plus, Pro, Business, Enterprise, or Edu). Then open **ChatGPT Plugins**, select **+**, and create an app named **BugRadar** with this server URL:
> >
> > ```text theme={null}
> > https://mcp.usebugradar.com/mcp
> > ```
> >
> > Choose **OAuth** and approve access in your browser. Do not use an API key. In a chat, open **+**, choose **Developer mode**, and select **BugRadar**. This connects the app in ChatGPT. It does not add a separate control inside the dot.
> >
> > Full walkthrough: [Dots](/docs/dots.md).
>
> > [tab] Grok Bot
> >
> > Grok Bot has no Settings form for a custom MCP URL, and BugRadar is not in the marketplace. Send this in a Grok Bot chat:
> >
> > ```
> > Add a custom MCP called BugRadar at https://mcp.usebugradar.com/mcp
> > ```
> >
> > Approve the confirm card. When Grok Bot shows a sign-in link, open it and approve access. No API key is needed. Next message: `@` BugRadar and ask it to list or run a flow. Adding MCP in Cursor does not set up Grok Bot.
> >
> > Full walkthrough: [Grok Bot](/docs/grok-bot.md).
>
> > [tab] Devin
> >
> > In Devin, open **Customize → MCPs → Add a custom MCP**. Choose **HTTP**, not STDIO. Open **[Settings → Integrations → Devin](https://usebugradar.com/settings?tab=integrations\&integration=devin)** to create a key, then fill in:
> >
> > ```
> > Server name: BugRadar
> > Transport: HTTP
> > Server URL: https://mcp.usebugradar.com/mcp
> > Authentication: Auth Header
> > Header key: x-api-key
> > Header value: <YOUR_API_KEY>
> > ```
> >
> > Save, then use **Test listing tools**. Adding MCP in Cursor does not set up Devin.
> >
> > Full walkthrough: [Devin](/docs/devin.md).
>
> > [tab] Hermes Agent
> >
> > Add this under `mcp_servers` in `~/.hermes/config.yaml` (keep any other servers). Hermes opens a browser the first time it connects:
> >
> > ```yaml theme={null}
> > mcp_servers:
> >   BugRadar:
> >     url: "https://mcp.usebugradar.com/mcp"
> >     auth: oauth
> > ```
> >
> > Or run `hermes mcp add --url https://mcp.usebugradar.com/mcp --auth oauth BugRadar`. Do not use `--auth header` — that writes `Authorization: Bearer`. Adding MCP in Cursor does not set up Hermes Agent.
> >
> > Full walkthrough: [Hermes Agent](/docs/hermes-agent.md).
>
> > [tab] OpenClaw
> >
> > Run:
> >
> > ```bash theme={null}
> > openclaw mcp set BugRadar '{"url":"https://mcp.usebugradar.com/mcp","transport":"streamable-http","auth":"oauth"}'
> > openclaw mcp login BugRadar
> > ```
> >
> > Follow the browser sign-in prompt.
>
> In the browser, sign in to BugRadar, check the agent name and company, and click **Connect**. The agent can work in any workspace you can access in that company. Return to your agent and ask it to list your BugRadar flows.
>
> If the authorization session ends before you approve, start a fresh connection from your agent. Do not reuse the old browser tab.
>
> Existing API-key connections continue to work. To switch one to browser sign-in, remove its `x-api-key` header and reconnect. Keep the key until the new connection works; revoke it only if no other integrations use it.
>
> **Note:** We recommend adding the MCP server at your project root so your agent has context across your frontend and backend.
>
> my-project/  ← project root
> ├── frontend/
> ├── backend/
> └── .mcp.json
>
> You may need to restart your agent for the changes to take effect.
>
> ### 2. Onboard
>
> Tell your agent:
>
> ```
> Onboard me to BugRadar
> ```
>
> It'll handle CI/CD setup, test planning and creation, and more.

> [tab] Manual
>
> ### Step 1: Add Your App or Website
>
> > [tab] Mobile
> >
> > **CI/CD Pipeline Integration (Recommended)**
> >
> > 1. Create an API key for your CI pipeline with [`BugRadar keys create`](/docs/install-cli) or in **[Settings → API Keys](https://usebugradar.com/settings?tab=api-keys)**
> > 2. Follow the setup guide to integrate with your pipeline (GitHub Actions, Fastlane, Expo EAS, etc.)
> > 3. Your first build will automatically create the app in BugRadar
> >
> > [Learn more about our CI/CD Integration →](/docs/ci-cd-integration.md)
> >
> > **Manual Upload**
> >
> > Get your build file ready (iOS: `.zip` containing your .app bundle, Android: `.apk`). [Learn how to build your app →](/docs/app-build-guide.md)
> >
> > 1. Navigate to the **[Apps](https://usebugradar.com/apps)** page from the sidebar
> > 2. Click **Create New App**
> > 3. Fill in app name, bundle ID, platform, and optionally an environment
> > 4. Drag and drop your build file, then click **Upload**
>
> > [tab] Web
> >
> > **CI/CD Pipeline Integration (Recommended)**
> >
> > 1. Create an API key for your CI pipeline with [`BugRadar keys create`](/docs/install-cli) or in **[Settings → API Keys](https://usebugradar.com/settings?tab=api-keys)**
> > 2. Follow the setup guide to integrate with your pipeline (Vercel, Netlify, etc.)
> > 3. Your preview URL will automatically be registered with BugRadar on every deploy
> >
> > [Learn more about our CI/CD Integration →](/docs/ci-cd-integration.md#web-setup)
> >
> > **Manual Setup**
> >
> > 1. Navigate to the **[Apps](https://usebugradar.com/apps)** page from the sidebar
> > 2. Click **Create New App**
> > 3. Enter your app name, URL, select **Web** as the platform, and click **Create**
>
> ### Step 2: Create Your First Flow
>
> A **Flow** is a test written in natural language that describes what you want to test.
>
> 1. Navigate to the **[Flows](https://usebugradar.com/flows)** page
> 2. Click **Create Flow**
> 3. Write your flow instructions in natural language:
>    ```
>    Open the app
>    Tap on the login button
>    Enter "test@example.com" in the email field
>    Enter "password123" in the password field
>    Tap the submit button
>    Verify that the home screen appears
>    ```
> 4. Click **Create Flow**
>
> See [Writing Effective Flow Instructions](/docs/writing-effective-flow-instructions.md) for our style guide on writing effective flows.
>
> ### Step 3: Run Your First Flow
>
> 1. Find your flow in the Flows table
> 2. Click the **Play** button (▶️) next to your flow
> 3. Select your app from the dropdown
> 4. Click **Run Flow**
>
> Your flow will now execute on our cloud infrastructure. You'll see real-time status updates as the flow progresses.
>
> ### Step 4: View Results
>
> Once your flow completes:
>
> 1. Click on the status badge (Passed/Failed) in the Flows table
> 2. View detailed results including:
>    * Screenshots at each step
>    * Actions performed by the agent
>    * Any errors encountered
>
> On the **Runs** page, open a batch's **Preview** and select **View details** to see its combined results. The address bar updates to a shareable batch URL. Closing the dialog restores your previous URL and filters.
>
> ### Next Steps
>
> > [card] [Suites](/docs/suites.md)
> >
> > Group related flows and run them together
>
> > [card] [Automations](/docs/automations.md)
> >
> > Schedule flows to run on builds, daily, or weekly
>
> > [card] [CI/CD](/docs/ci-cd-integration.md)
> >
> > Upload builds automatically from your pipeline


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.