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

# Quick Start Guide

> Step-by-step onboarding guide for GitHub, Salesforce, API keys, CI setup, and Jira integration.

# Quick Start Guide

Use this guide to set up Jataka with GitHub, Salesforce, CI secrets, and Jira in a production-ready way.

<Steps>
  <Step>
    <img src="https://mintcdn.com/jataka/nqKBEiRUZfJ-ZBUD/static/images/1.png?fit=max&auto=format&n=nqKBEiRUZfJ-ZBUD&q=85&s=a477ebcabe102052c5a33c166b280542" alt="Step 1 - Connect GitHub" width="1687" height="690" data-path="static/images/1.png" />

    Connect your GitHub account from the Jataka dashboard.
    Authorize repository access for the organization you want to onboard.
  </Step>

  <Step>
    <img src="https://mintcdn.com/jataka/nqKBEiRUZfJ-ZBUD/static/images/2.png?fit=max&auto=format&n=nqKBEiRUZfJ-ZBUD&q=85&s=7bd445b82bf896daba2055b745052f72" alt="Step 2 - Select GitHub Repository" width="693" height="797" data-path="static/images/2.png" />

    Select the GitHub repository where your Salesforce metadata and workflows are maintained.
    Confirm that the selected repository is the same one used for your release process.
  </Step>

  <Step>
    <img src="https://mintcdn.com/jataka/nqKBEiRUZfJ-ZBUD/static/images/3.png?fit=max&auto=format&n=nqKBEiRUZfJ-ZBUD&q=85&s=2ee4d584391b7e1d028ef95d54d05429" alt="Step 3 - Select Branch and Brain" width="560" height="575" data-path="static/images/3.png" />

    Select the target branch that should run Jataka checks.
    If your workspace uses Brain profiles, choose the appropriate Brain for this repository.
  </Step>

  <Step>
    <img src="https://mintcdn.com/jataka/nqKBEiRUZfJ-ZBUD/static/images/4.png?fit=max&auto=format&n=nqKBEiRUZfJ-ZBUD&q=85&s=4ae9ffe0092f0a6ea831067cc7964b57" alt="Step 4 - Connect Salesforce Org" width="1734" height="779" data-path="static/images/4.png" />

    Connect Salesforce and choose the correct environment: production (`login.salesforce.com`) or sandbox (`test.salesforce.com`).
    Verify that the connected org matches the environment used by your deployment pipeline.
  </Step>

  <Step>
    <img src="https://mintcdn.com/jataka/nqKBEiRUZfJ-ZBUD/static/images/5.png?fit=max&auto=format&n=nqKBEiRUZfJ-ZBUD&q=85&s=22bb5e4a549eed486cecbec50f8bbe39" alt="Step 5 - Approve Salesforce Permissions" width="718" height="937" data-path="static/images/5.png" />

    Allow all the permissions
  </Step>

  <Step>
    <img src="https://mintcdn.com/jataka/nqKBEiRUZfJ-ZBUD/static/images/6.png?fit=max&auto=format&n=nqKBEiRUZfJ-ZBUD&q=85&s=0c405c56d55f6e58638fb87b76314754" alt="Step 6 - Generate SFDX Auth URL" width="677" height="870" data-path="static/images/6.png" />

    Authenticate your target Salesforce org in the CLI first:

    ```bash theme={null}
    sf org login web --alias staging-org
    ```

    Then display the org details and copy the generated SFDX auth URL:

    ```bash theme={null}
    sf org display --target-org staging-org --verbose
    ```
  </Step>

  <Step>
    <img src="https://mintcdn.com/jataka/nqKBEiRUZfJ-ZBUD/static/images/7.png?fit=max&auto=format&n=nqKBEiRUZfJ-ZBUD&q=85&s=d0a71a92dd05258443be6728e289ee02" alt="Step 7 - Add SFDX URL as GitHub Secret" width="1711" height="973" data-path="static/images/7.png" />

    **Optional:** Add the generated auth URL as a GitHub Actions secret as `SFDX_AUTH_URL`.
    Add this to your workflow file to make sure changes are deployed the testing environment before running tests:

    ```yaml theme={null}
    - name: Authenticate to Salesforce
      run: |
        echo "${{ secrets.SFDX_AUTH_URL }}" > auth_url.txt
        sf org login sfdx-url --sfdx-url-file auth_url.txt --set-default --alias staging-org
        rm auth_url.txt
    ```
  </Step>

  <Step>
    <img src="https://mintcdn.com/jataka/nqKBEiRUZfJ-ZBUD/static/images/8.png?fit=max&auto=format&n=nqKBEiRUZfJ-ZBUD&q=85&s=2a431ac0467f9172fe98c066f32d4cf0" alt="Step 8 - Generate Jataka API Key" width="1227" height="862" data-path="static/images/8.png" />

    Generate the Jataka API key from the integration setup panel (Step 3 flow).
    Save it in GitHub Secrets as `JATAKA_API_KEY` the same way as other credentials.
  </Step>

  <Step>
    <img src="https://mintcdn.com/jataka/nqKBEiRUZfJ-ZBUD/static/images/9.png?fit=max&auto=format&n=nqKBEiRUZfJ-ZBUD&q=85&s=87862ad6f0c0b0f034acb1e5a1ffe83b" alt="Step 9 - Add Workflow Command and Test Mode" width="985" height="828" data-path="static/images/9.png" />

    Add this step to your project workflow file (for example, `.github/workflows/deploy.yml`) after Salesforce deployment:

    ```yaml theme={null}
    - name: Trigger Jataka AI UI Tests
      # Put this step AFTER your Salesforce deployment step (Gearset, Copado, or SFDX)
      run: |
        curl -X POST "${{ secrets.JATAKA_API_URL }}/api/integrations/github/trigger" \
          -H "Authorization: Bearer ${{ secrets.JATAKA_API_KEY }}" \
          -H "Content-Type: application/json" \
          -d '{
            "installation_id": "YOUR_INSTALLATION_ID", 
            "repo_full_name": "${{ github.repository }}",
            "branch": "${{ github.head_ref || github.ref_name }}",
            "pr_number": ${{ github.event.pull_request.number || 'null' }},
            "test_mode": "${{ vars.JATAKA_TEST_MODE || 'auto' }}",
            "action": "${{ github.event.action }}",
            "before_sha": "${{ github.event.before }}"
          }'
    ```

    Create a GitHub Actions variable named `JATAKA_TEST_MODE` and set it based on your need under the actions -> variable.
  </Step>

  <Step>
    <img src="https://mintcdn.com/jataka/nqKBEiRUZfJ-ZBUD/static/images/10.png?fit=max&auto=format&n=nqKBEiRUZfJ-ZBUD&q=85&s=e24f6bfd14e775bd260d5ff724de79c1" alt="Step 10 - Connect Jira Account" width="680" height="667" data-path="static/images/10.png" />

    Connect your Jira account so Jataka can read ticket context tied to branches, commits, or pull requests.
    Ensure the Jira site selected is the one used by your engineering teams.
  </Step>

  <Step>
    <img src="https://mintcdn.com/jataka/nqKBEiRUZfJ-ZBUD/static/images/11.png?fit=max&auto=format&n=nqKBEiRUZfJ-ZBUD&q=85&s=467fe0569e8c183863c3bb710c76fd7f" alt="Step 11 - Approve Jira Permissions" width="921" height="817" data-path="static/images/11.png" />

    Allow all the permissions and  click **Accept**.
  </Step>

  <Step>
    <img src="https://mintcdn.com/jataka/nqKBEiRUZfJ-ZBUD/static/images/12.png?fit=max&auto=format&n=nqKBEiRUZfJ-ZBUD&q=85&s=af96a41e9800e35ab312643827961f89" alt="Step 12 - Set Jira Project Key" width="690" height="217" data-path="static/images/12.png" />

    Set the exact Jira project key that should be used for ticket lookup.
    Validate the key format and test one linked ticket before enabling for all pipelines.
  </Step>

  <Step>
    <img src="https://mintcdn.com/jataka/MPk7QpXwE9fKC6nw/static/images/13.png?fit=max&auto=format&n=MPk7QpXwE9fKC6nw&q=85&s=fe89f94cd100e920cb1ee19dd38709a2" alt="Step 13 - Use Jira Ticket in PR Title" width="1012" height="120" data-path="static/images/13.png" />

    Include the Jira ticket number in the pull request title so Jataka can derive ticket context for test execution.
    Example format: `PROJ-123: Improve lead conversion validation`.
  </Step>
</Steps>

<Callout type="success">
  Setup complete: your repository, Salesforce org, secrets, workflow checks, and Jira context are now aligned for automated Jataka validation.
</Callout>

## MCP Server Setup (VS Code)

To use governed, context-aware coding directly in your IDE, install and authenticate the Jataka VS Code extension using your dashboard auth token.

Read the full setup and tool guide here: [MCP Server for VS Code](/mcp-server)
