> ## 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 ([book a demo to get access](https://calendly.com/yuvan-autosana/30min))
* A mobile app or website that you want to test (duh)

## Getting Started

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

    <Tip>
      We highly recommend adding the MCP to the **root of your project** to give the agent optimal context.

      ```
      my-project/        ← run setup here
      ├── frontend/
      ├── backend/
      └── .mcp.json
      ```
    </Tip>

    Replace `<YOUR_API_KEY>` with your key from the welcome quickstart or [**Settings → Integrations → API Key**](https://autosana.ai/settings?tab=integrations).

    <Tabs>
      <Tab title="Claude Code">
        Run this command in your terminal:

        ```bash theme={null}
        claude mcp add --transport http autosana https://mcp.autosana.ai/mcp --header "x-api-key: <YOUR_API_KEY>"
        ```
      </Tab>

      <Tab title="Claude Desktop">
        **Add this to**: `~/claude_desktop_config.json`

        ```json theme={null}
        {
          "mcpServers": {
            "autosana": {
              "url": "https://mcp.autosana.ai/mcp",
              "headers": {
                "x-api-key": "<YOUR_API_KEY>"
              }
            }
          }
        }
        ```
      </Tab>

      <Tab title="Cursor">
        **Add this to**: `~/.cursor/mcp.json`

        ```json theme={null}
        {
          "mcpServers": {
            "autosana": {
              "url": "https://mcp.autosana.ai/mcp",
              "headers": {
                "x-api-key": "<YOUR_API_KEY>"
              }
            }
          }
        }
        ```
      </Tab>

      <Tab title="Gemini CLI">
        Run this command in your terminal:

        ```bash theme={null}
        gemini mcp add --transport http autosana https://mcp.autosana.ai/mcp --header "x-api-key: <YOUR_API_KEY>"
        ```

        Or add this to your `~/.gemini/settings.json`:

        ```json theme={null}
        {
          "mcpServers": {
            "autosana": {
              "httpUrl": "https://mcp.autosana.ai/mcp",
              "headers": {
                "x-api-key": "<YOUR_API_KEY>"
              }
            }
          }
        }
        ```
      </Tab>

      <Tab title="Codex">
        **Add this to**: `~/.codex/config.toml`

        ```toml theme={null}
        [mcp_servers.autosana]
        url = "https://mcp.autosana.ai/mcp"
        http_headers = { "x-api-key" = "<YOUR_API_KEY>" }
        ```
      </Tab>

      <Tab title="OpenClaw">
        **Add this to**: `~/.openclaw/openclaw.json`

        ```json theme={null}
        {
          "mcpServers": {
            "autosana": {
              "url": "https://mcp.autosana.ai/mcp",
              "headers": {
                "x-api-key": "<YOUR_API_KEY>"
              }
            }
          }
        }
        ```

        Or via mcporter, **add this to**: `~/.mcporter/mcporter.json`

        ```json theme={null}
        {
          "mcpServers": {
            "autosana": {
              "url": "https://mcp.autosana.ai/mcp",
              "headers": {
                "x-api-key": "<YOUR_API_KEY>"
              }
            }
          }
        }
        ```
      </Tab>
    </Tabs>

    After adding the configuration, 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. Copy your API key from the welcome quickstart after checkout, or later from **[Settings → Integrations](https://autosana.ai/settings?tab=integrations)**
        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. Copy your API key from the welcome quickstart after checkout, or later from **[Settings → Integrations](https://autosana.ai/settings?tab=integrations)**
        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**

    ### 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

    ### 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>