Documentation
Shield docsGet started

Shield documentation

Shield checks coding-agent requests against your project’s permission rules.

Start with What is Shield?, then set up your first project.

For an existing project, choose a task below or go to troubleshooting.

Get started

  • What is Shield?: why you would use it, its main concepts, and the boundary between policy and agent enforcement.
  • Your first project: initialize policy, connect an agent, and check the installation.
  • Understand policy decisions: Allow, Ask, Deny, profiles, and the difference between a decision and what the host does next.
  • Use the terminal: picker controls, reviews, JSON output, and a command overview.

Work with your project

Write and look up rules

  • Write your first rule: start with one exact command, then learn argument matching, path restrictions, web rules, and reusable pack rules.
  • Rule reference: look up document fields, rule fields, selectors, and required capabilities.
  • Validate permission packs: check artifacts and test expected decisions without executing the commands.

Use Shield from an agent

  • Project MCP: inspect policy, read these guides, propose a change, request approval, and evaluate diagnostic requests.

Integrate with Shield

For developers embedding Shield in a host application:

  • Claude SDK integration: integrate the restricted text-read consumer and its one-time approval flow.
  • Native execution: use the separate bounded macOS runner for checked launches and owned process cleanup.
  • Enforcement handoff: understand the transport contract when embedding enforcement in a trusted host.

Recovery and development details