Quickstart

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

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

Let your agent handle setup

Your agent handles setup. You verify your account and approve your first Rule.

Set up Synkro for my agent and this repository. Use the latest released CLI, not a local source build. Follow https://docs.synkro.sh/quickstart and the steps below. Keep updates short. Stop only for missing account access, a required human sign-in or approval, or an error you cannot safely resolve.

Start registration on my behalf and connect to my account after I claim it and approve the connection. You cannot claim the account or approve yourself. If I am already signed in on this installation, preserve it and ask whether to continue that setup or use a separate installation for your limited connection.

This signup is for the sandbox. Set SYNKRO_WEB_AUTH_URL=https://app.sandbox.synkro.sh for every setup command and resumed session. Keep sandbox credentials separate from any production installation. Use test cards only; the $20 starter credit is a sandbox test balance, not production funds. Never enter a real card.

If this prompt is pasted again after sign-in or a restart, inspect the current state and continue from the first incomplete step. Do not reinstall everything.

Pause for me to verify my email, review the terms, approve the connection and save a test card on the returned Synkro page. Continue setup when those steps finish. The $20 starter credit is awarded after the saved card is confirmed.

After installing or updating the CLI binary, check synkro onboard --help, synkro onboard claim --help and synkro onboard verify --help. Read https://app.sandbox.synkro.sh/auth.md and follow that guide for signup, connecting the agent, installation and scoped Rule verification. For an administrator-provided test service, use /auth.md on that approved App origin instead, keeping existing accounts and environments separate. If commands are still missing after updating, or the guide or service is unavailable, stop and report the version and error. Do not switch services or use my personal sign-in credentials to get past a restriction. A fresh install uses Synkro's hosted service. Add --daemon-url only for the verified service selected by account setup or supplied by the administrator.

For a new account, after installing the CLI and checking for saved progress, run synkro onboard start --email EMAIL --json using the email I provide. This adds my email to the waitlist. Once the Synkro team approves my request, I can claim my account so you can continue setup. While the next action is review_application, use synkro onboard resume --wait-seconds 300 --json to check the saved request; do not submit it again. If I prefer to request access myself, give me https://synkro.sh/request-access and continue with that same email. Website and CLI requests join the same waitlist.

1. Identify the OS, architecture, current repository, and installed agent. Use git rev-parse --show-toplevel and git status --short. Ask which repository only if it is unclear. Check command -v synkro, synkro --version, synkro whoami --json, and synkro status --json when available. Missing commands are normal on a fresh machine. An approved Synkro account in an organization is required; a waitlist entry is not enough.

2. On Linux, prefer the verified direct download at https://docs.synkro.sh/onboarding/install#linux-without-homebrew. It installs into the user's binary directory without sudo, a compiler, OpenSSL packages or Homebrew. Follow the pinned release's archive and checksum steps exactly, and add the directory to PATH. On macOS, use Homebrew. For a fresh install, run:
   brew install synkro-sh/tap/synkro
   Homebrew may add compiler and system-library dependencies on older Linux distributions; do not force an unsupported Homebrew install or ignore its dependency checks. For an existing Homebrew installation, run brew update and brew upgrade synkro-sh/tap/synkro. If the selected synkro executable is a development build or from a different installer, report the path and ask before replacing it. Do not invent a download URL, skip a checksum, or install an unsupported build. Check synkro --version afterward.

3. For a connection approved through synkro onboard, finish setup using the signup guide above, then use its scoped evidence commands instead of the general event feed in steps 8 and 9. Only if I chose to continue my existing signed-in setup, run synkro install. For a terminal without a usable browser, use synkro install --no-browser. Keep it running while I approve the printed URL and short code; if only a code appears, use https://app.sandbox.synkro.sh/device. Check the terminal result and synkro whoami --json. Preserve existing service settings. Do not ask for passwords or tokens in chat. Retry an expired device code at most once with a fresh code. Report other failures instead of repeatedly retrying.

4. In the selected repository, preserve existing synkro.toml and Rule files. If no project is configured, run synkro init, show me the files it created and the dependencies it copied, then run synkro lock. The public cwe-baseline dependency must resolve. If it fails, check network and repository access, retry synkro lock --path ~/.synkro, then synkro lock in the project. Do not remove a dependency, accept a partial lock, weaken existing Rules or Controls, change AGENTS.md, or overwrite unrelated settings. Report invalid configuration instead of replacing it. A new custom rule is allowed only after I approve the complete proposal described below.

5. Run synkro status --json. For stale installed components, run synkro update --yes once, then check status again. This updates components, not the CLI itself. Confirm the saved identity and organization, an answering endpoint, and active health.enforcement.state. Keep unknown, null, paused, or failed results explicit. Report semantic checking separately if it is unavailable. Do not add funds or change account settings as part of setup.

6. Check the current agent's configuredHarnesses and plugins status. Codex also needs configuredMcp.codex and plugins.codex.toolBoundaryReady. Ask me to review hook trust in the agent UI if needed. Never bypass an approval, grant trust on my behalf, or treat a null value as true.

7. Ask me to start a new agent session in this repository so it loads the integration. Give me the shortest continuation prompt needed to finish verification. In the new session, run git status --short through an agent tool without changing files.

8. Run synkro events --type verdict --limit 5 --details. Results include other users and machines in the organization. Match a new verdict.created event to the command, time, and session. Follow its correlation_id with synkro events --correlation UUID --details if needed. For a block test, use the marker command from https://docs.synkro.sh/guides/rules#test-a-rule after I approve that Rule.

9. Report the CLI version and path, repository, account and organization, service state, current agent integration, and the new decision's ID and outcome. If verification is incomplete, say exactly what remains. Do not claim success from installation alone. A paused or failed-open Allow is not a governed success.

During independent setup steps, start a short conversation about one useful rule for this project. Read https://docs.synkro.sh/prompts/onboard-synkro.md for the shared onboarding workflow. Prefer my explicit instructions and documented project requirements over inferred conventions. Use context already available, inspect only relevant files, and check existing rules for duplicates. Historical PR scanning is optional. If there is not enough context, ask: "What do you repeatedly have to correct your agent about?"

Show the complete proposed rule file, scope, exceptions, mode, remediation, two to four violating examples and a nearby allowed example. Wait for my explicit approval before writing it. Signup approval does not approve a rule. If I change or reject the proposal, adapt or skip it; do not block account setup. An unchanged approved proposal needs no second approval. Follow the manage-synkro-rules skill when available, otherwise https://docs.synkro.sh/guides/rules. Run synkro lock and synkro check --rule <approved-id> --json after the approved change, honoring any required permission for model usage. Never execute example commands. Do not hide failures or skipped checks.

First-rule verification needs both passing checks and a new real governed action under the approved active policy. Match its installation, session, project and policy generation. Report whether the action checked the integration, matched the specific Rule, or both. Let me skip rule creation while still completing installation.

If you find a Synkro bug or a useful improvement, describe it to me. When I ask you to report it or authorize sending feedback, follow https://docs.synkro.sh/guides/feedback. Check synkro --help for command availability first. Use my approved agent connection, the affected repository, and any existing failure IDs; let the command attach diagnostics instead of asking me to assemble traces. Report the submission ID and delivery status, reuse the saved report for retries, and keep a draft if the command or sign-in is unavailable. Do not switch accounts or services to submit feedback.

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

After installing the CLI, your agent requests access with:

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:

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, then have your agent continue with the same email. Website and CLI requests join the same waitlist.

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.

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.

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 and the Rules guide. If setup stops, follow Troubleshooting and resume the existing request.

Prefer to run the setup commands yourself? Use Install and verify.

Report a problem or suggestion

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