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

# Quickstart

## Prerequisites

* An Autosana account ([sign up](https://autosana.ai/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://autosana.ai/overview) shows what's left. Click **Restart setup** on that card to go through it again.

## Getting Started

<Tabs>
  <Tab title="Automated (Recommended)">
    ### 1. Add the MCP Server

    Connect Autosana with your existing account using browser sign-in. Grok Bot and Devin currently use the API-key setup described below.

    <Tabs>
      <Tab title="Claude Code">
        Run in your project directory:

        ```bash theme={null} theme={null}
        claude mcp add --transport http autosana https://mcp.autosana.ai/mcp
        ```

        Open Claude Code, run `/mcp`, select Autosana, and follow the browser sign-in prompt.
      </Tab>

      <Tab title="Claude Desktop">
        In Claude, open **Customize → Connectors → Add custom connector**. Enter **Autosana** as the name and this server URL:

        ```text theme={null} theme={null}
        https://mcp.autosana.ai/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>

      <Tab title="Cursor">
        Add Autosana to `~/.cursor/mcp.json`, preserving any existing servers:

        ```json theme={null} theme={null}
        {
          "mcpServers": {
            "autosana": {
              "url": "https://mcp.autosana.ai/mcp"
            }
          }
        }
        ```

        Open Cursor's MCP settings and click **Authenticate** beside Autosana.
      </Tab>

      <Tab title="Gemini CLI">
        Run:

        ```bash theme={null} theme={null}
        gemini mcp add --transport http autosana https://mcp.autosana.ai/mcp
        ```

        In Gemini CLI, run `/mcp auth autosana` and follow the browser sign-in prompt.
      </Tab>

      <Tab title="Codex">
        Run:

        ```bash theme={null} theme={null}
        codex mcp add autosana --url https://mcp.autosana.ai/mcp
        codex mcp login autosana
        ```

        If you configure Codex manually, add the following to `~/.codex/config.toml`, then run `codex mcp login autosana`:

        ```toml theme={null} theme={null}
        [mcp_servers.autosana]
        url = "https://mcp.autosana.ai/mcp"
        ```
      </Tab>

      <Tab title="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 **Autosana** with this server URL:

        ```text theme={null} theme={null}
        https://mcp.autosana.ai/mcp
        ```

        Choose **OAuth** and approve access in your browser. Do not use an API key. In a chat, open **+**, choose **Developer mode**, and select **Autosana**. This connects the app in ChatGPT. It does not add a separate control inside the dot.

        Full walkthrough: [Dots](/dots).
      </Tab>

      <Tab title="Grok Bot">
        Grok Bot has no Settings form for a custom MCP URL, and Autosana is not in the marketplace. Open **[Settings → Integrations → Grok Bot](https://autosana.ai/settings?tab=integrations\&integration=grok-bot)** to create a key, then send this in a Grok Bot chat:

        ```
        Add a custom MCP called Autosana at https://mcp.autosana.ai/mcp with header x-api-key: <YOUR_API_KEY>
        ```

        Approve the confirm card. Next message: `@` Autosana and ask it to list or run a flow. Adding MCP in Cursor does not set up Grok Bot.

        Full walkthrough: [Grok Bot](/grok-bot).
      </Tab>

      <Tab title="Devin">
        In Devin, open **Customize → MCPs → Add a custom MCP**. Choose **HTTP**, not STDIO. Open **[Settings → Integrations → Devin](https://autosana.ai/settings?tab=integrations\&integration=devin)** to create a key, then fill in:

        ```
        Server name: Autosana
        Transport: HTTP
        Server URL: https://mcp.autosana.ai/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](/devin).
      </Tab>

      <Tab title="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} theme={null}
        mcp_servers:
          autosana:
            url: "https://mcp.autosana.ai/mcp"
            auth: oauth
        ```

        Or run `hermes mcp add --url https://mcp.autosana.ai/mcp --auth oauth autosana`. Do not use `--auth header` — that writes `Authorization: Bearer`. Adding MCP in Cursor does not set up Hermes Agent.

        Full walkthrough: [Hermes Agent](/hermes-agent).
      </Tab>

      <Tab title="OpenClaw">
        Run:

        ```bash theme={null} theme={null}
        openclaw mcp set autosana '{"url":"https://mcp.autosana.ai/mcp","transport":"streamable-http","auth":"oauth"}'
        openclaw mcp login autosana
        ```

        Follow the browser sign-in prompt.
      </Tab>
    </Tabs>

    In the browser, sign in to Autosana, 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 Autosana 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.

    <div className="not-prose my-6 border-l border-gray-200 pl-4 text-sm text-gray-500 dark:border-gray-800 dark:text-gray-400">
      <p>
        <strong>Note:</strong> We recommend adding the MCP server at your project root so your agent has context across your frontend and backend.
      </p>

      <div className="mt-3 whitespace-pre font-mono text-xs leading-5">
        {"my-project/  ← project root\n├── frontend/\n├── backend/\n└── .mcp.json"}
      </div>
    </div>

    You may need to restart your agent for the changes to take effect.

    ### 2. Onboard

    Tell your agent:

    ```
    Onboard me to Autosana
    ```

    It'll handle CI/CD setup, test planning and creation, and more.
  </Tab>

  <Tab title="Manual">
    ### Step 1: Add Your App or Website

    <Tabs>
      <Tab title="Mobile">
        **CI/CD Pipeline Integration (Recommended)**

        1. Create an API key for your CI pipeline with [`autosana keys create`](/install-cli) or in **[Settings → API Keys](https://autosana.ai/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 Autosana

        [Learn more about our CI/CD Integration →](/ci-cd-integration)

        **Manual Upload**

        Get your build file ready (iOS: `.zip` containing your .app bundle, Android: `.apk`). [Learn how to build your app →](/app-build-guide)

        1. Navigate to the **[Apps](https://autosana.ai/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>

      <Tab title="Web">
        **CI/CD Pipeline Integration (Recommended)**

        1. Create an API key for your CI pipeline with [`autosana keys create`](/install-cli) or in **[Settings → API Keys](https://autosana.ai/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 Autosana on every deploy

        [Learn more about our CI/CD Integration →](/ci-cd-integration#web-setup)

        **Manual Setup**

        1. Navigate to the **[Apps](https://autosana.ai/apps)** page from the sidebar
        2. Click **Create New App**
        3. Enter your app name, URL, select **Web** as the platform, and click **Create**
      </Tab>
    </Tabs>

    ### 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://autosana.ai/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](/writing-effective-flow-instructions) 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

    <CardGroup cols={3}>
      <Card title="Suites" icon="folder" href="/suites">
        Group related flows and run them together
      </Card>

      <Card title="Automations" icon="clock" href="/automations">
        Schedule flows to run on builds, daily, or weekly
      </Card>

      <Card title="CI/CD" icon="code-branch" href="/ci-cd-integration">
        Upload builds automatically from your pipeline
      </Card>
    </CardGroup>
  </Tab>
</Tabs>


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