What is Synkro?A package manager for agents, with Rules for using your software.Getting startedQuickstartLet your agent set up Synkro, create your first Rule, and verify an action.Getting startedSetup checklistCheck your account, installation, repository, and first agent decision.SetupInstall and verifyInstall the CLI, sign in, and connect your agent.SetupSet up your agentConnect your agent and verify its first tool call.SetupVerify a decisionFind the recorded decision for an agent action.SetupYour first decisionRead your first agent decision and test a Rule.SetupHow Synkro worksUnderstand how Synkro applies Rules and records agent decisions.Core conceptsRules and ControlsChoose repository Rules for actions and Controls for access restrictions.Core conceptsRule outcomesUnderstand when an action continues, needs approval, or must be changed.Core conceptsRulesAdd, test, update, and remove the Rules used by your repository.GuidesEventsFind recorded agent actions and decisions with the Synkro CLI.GuidesApprove MCP toolsChoose project approvals and package defaults for MCP tools.GuidesConsentReview and approve an agent action before it runs.GuidesFeedbackReport a Synkro bug or suggest an improvement with diagnostic context.GuidesBilling and usageAdd funds and check your organization's balance and usage.GuidesGitHubConnect GitHub to discover Rules from private repositories.IntegrationsCLI commandsFind the current commands for setup, Rules, events, account, and recovery.ReferenceSupported agentsFind the installed Synkro files and the checks that apply to each agent.ReferenceTroubleshootingFix setup, sign-in, missing decisions, Rule, and approval problems.Reference
Documentation
Onboarding

Set up your agent

Connect your agent and verify its first tool call.

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.

Run synkro install after installing your agent. Start a new session in a repository with synkro.toml and synkro.lock, then verify a new decision.

Claude Code

Complete Claude Code's sign-in and first-run setup, including its interactive prompts after claude auth login.

  1. Exit the old session and start a new one.
  2. Look for the [⧉ synkro] startup notice.
  3. Check configuredHarnesses.claude_code in synkro status --json.
  4. Follow Verify a decision.

Synkro also sets a shutdown-hook timeout in ~/.claude/settings.json when you have not set one yourself. This lets the SessionEnd hook finish. Existing overrides are preserved. See SessionEnd hook cancelled.

Codex

  1. Start a new session and send a prompt.
  2. Review and trust Synkro's current hooks in Codex's Hooks settings. In the terminal interface, use /hooks.
  3. Check that the Synkro MCP server is enabled. In the terminal interface, use /mcp.
  4. Run synkro status --json. Check configuredHarnesses.codex, configuredMcp.codex, and plugins.codex.toolBoundaryReady.
  5. Follow Verify a decision.

If plugins.codex.hooksTrusted is null, confirm hook trust in Codex's Hooks settings. See OpenAI's hook documentation.

Synkro configures Codex to use execution paths that support its hooks, with Code Mode disabled. Connected-tool access may need owner approval; see Synkro MCP.

Google Antigravity

Start a new session, check configuredHarnesses.antigravity, then verify a decision. No startup notice is expected for Antigravity.

Cursor

Start a new Agent session and check configuredHarnesses.cursor. Use Cursor's plugin settings for enabled or trusted states that Synkro cannot report. Then verify a decision.

If a new decision does not appear, follow Troubleshooting. A null status means the setting could not be reported; check it in the agent's interface.