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
Core concepts

How Synkro works

Understand how Synkro applies Rules and records agent decisions.

Synkro checks a supported agent's action against your repository's Rules and any applicable Controls before the agent runs it. It records the result and tells the agent whether to continue. See Supported agents for the actions each integration covers.

Two kinds of checks

A deterministic check matches an exact condition, such as a command, file path or tool name.

A semantic check assesses what an action does against a Rule written in natural language, using the action's context.

Both use the Rule's configured outcome.

Rules belong to projects

A project's synkro.toml lists its Rule packages. Run synkro lock to check them and write synkro.lock.

Run synkro init in a new project. A repository without synkro.toml has no project Rules.

Read Rules for setup and updates.

What gets recorded?

Synkro records actions, decisions, and matching Rules and Controls, including prompts, commands, file edits, and tool results.

Your organization's history is stored in Synkro's hosted service.

Use Events to inspect them.

When something is unavailable

  • Account access cannot be confirmed: Rules pause. Agent actions continue with a notice.
  • A semantic check fails or a hook cannot be parsed: the action can continue with an error notice. This is not a passing Rule check.
  • The session service cannot run the check or spend an approval: Synkro refuses the action.
  • Recording the incoming action fails: the check can be refused with a storage error.

Run synkro status to check enforcement and service health. Follow Troubleshooting for the reported issue.