# Quickstart

> Let your agent set up Synkro, create your first Rule, and verify an action.

Source: https://docs.synkro.sh/quickstart

For the setup below, open a Git repository in Claude Code, Codex, Cursor or Google Antigravity on Apple Silicon macOS or supported Linux.

Synkro is in public preview. If your agent isn't listed here, email [team@synkro.sh](mailto:team@synkro.sh) and we can enable it for you or build a custom integration.

## Using an AI agent?

Copy the prompt below into your agent's chat. It handles signup, installation and your first Rule. You claim your account and approve the Rule it proposes.

<section class="agent-setup-callout" aria-labelledby="agent-setup-title">
  <div class="agent-setup-heading">
    <svg viewBox="0 0 24 24" aria-hidden="true"><path d="M9 18h6M10 22h4M8.4 14.4A7 7 0 1 1 15.6 14.4C14.6 15.2 14 16.1 14 17h-4c0-.9-.6-1.8-1.6-2.6Z"></path></svg>
    <div>
      <strong id="agent-setup-title">Let your agent handle setup</strong>
      <p>Your agent handles setup. You verify your account and approve your first Rule.</p>
    </div>
  </div>
  <div class="agent-prompt-card">
    <p class="agent-prompt-summary">Sign up, set up this repository, and verify a first Rule with your agent.</p>
    <div class="agent-prompt-actions">
      <div class="agent-harnesses" aria-label="Supported agents">
        <img src="https://www.google.com/s2/favicons?domain=claude.ai&sz=32" alt="Claude Code" title="Claude Code" referrerpolicy="no-referrer" />
        <img src="/codex-color.svg" alt="Codex" title="Codex" />
        <img src="https://www.google.com/s2/favicons?domain=cursor.com&sz=32" alt="Cursor" title="Cursor" referrerpolicy="no-referrer" />
        <img src="https://antigravity.google/favicon.ico" alt="Google Antigravity" title="Google Antigravity" referrerpolicy="no-referrer" />
      </div>
      <span class="copy-status" data-copy-status aria-live="polite"></span>
      <button type="button" data-copy-prompt>
        <svg viewBox="0 0 24 24" aria-hidden="true"><rect x="8" y="8" width="11" height="11" rx="2"></rect><path d="M16 8V6a2 2 0 0 0-2-2H6a2 2 0 0 0-2 2v8a2 2 0 0 0 2 2h2"></path></svg>
        <span>Copy prompt</span>
      </button>
    </div>
    <!-- setup-prompt -->
  </div>
</section>

## 1. Request access

To get started, your agent can add your email to the waitlist. You don’t need to join beforehand. Once our team approves your request, verify your email and claim your account so your agent can continue setup.

Have a use case you’re excited to try with Synkro? We’d love to hear about it. Email [team@synkro.sh](mailto:team@synkro.sh) with a little about yourself and what you’re building. Include the email address you used to request access so we can find your application.

This guide uses the sandbox. Keep an existing production installation separate. The copied prompt selects the sandbox for your agent and preserves your existing setup.

Agent signup instructions: [https://app.sandbox.synkro.sh/auth.md](https://app.sandbox.synkro.sh/auth.md).

After [installing the CLI](/onboarding/install), your agent requests access with:

```sh
export SYNKRO_WEB_AUTH_URL="https://app.sandbox.synkro.sh"
synkro onboard start --email EMAIL --json
```

Replace `EMAIL` with your email. While the next step is `review_application`, your request is waiting for our team to review it. Check the existing request with:

```sh
synkro onboard resume --wait-seconds 300 --json
```

If setup was already started, resume it instead of submitting again. For an existing approved account, follow the signup guide's account-claim steps.

Prefer to request access yourself? Use [Request access](https://synkro.sh/request-access), then have your agent continue with the same email. Website and CLI requests join the same waitlist.

## 2. Claim your account

Open the link your agent gives you. Verify your email, review the terms and permissions, then click **Claim account and connect agent**.

For a new organization, save a test card when prompted. Use `4242 4242 4242 4242`, a future expiry and any three-digit test CVC. Never enter a real card in sandbox. The $20 sandbox starter credit appears after the saved card is confirmed.

Return to the agent's chat. It picks up the approved connection and finishes setup. There is no connection code to copy after card setup.

## 3. Choose your first Rule

While setup runs, your agent discusses a useful Rule based on your instructions and repository. Tell it what you often have to correct, or ask it to suggest a boundary for your project.

Review the proposed Rule and its examples in chat. You can change it, approve it or skip it. After your approval, the agent adds the Rule, updates `synkro.lock` and checks the examples.

Start a new agent session and approve the Synkro hooks if setup asks you to. The copied prompt can resume in that session without starting over.

## 4. Verify an action

Your agent runs a tool action to test the Rule and uses `synkro onboard verify` to check the published Rule and the new decision. It reports your account, organization, project, Rule and decision ID with the outcome.

Verification links the action from your new session to the published Rule. If you skipped Rule creation, your agent confirms account setup and lists Rule creation as the next step.

For more detail, see [Verify a decision](/onboarding/verify-events) and the [Rules guide](/guides/rules). If setup stops, follow [Troubleshooting](/troubleshooting#agent-account-claim-did-not-finish) and resume the existing request.

Prefer to run the setup commands yourself? Use [Install and verify](/onboarding/install).

## Report a problem or suggestion

If you or your agent find unexpected behavior or a useful improvement, follow [Feedback](/guides/feedback). The guide covers command availability, what to include, automatic diagnostics, and checking delivery without submitting duplicates.