Documentation

ORBIT docs

Practical guides for installing and operating Guardian. Start here when you want commands, files, and checks.

Start here

For operators

Human Start Here

A plain-English entry point: what ORBIT is, what your phone will do, what proof you get, and where the limits are.

For agents

AI Start Here

The agent-side contract: route tool calls through the hook, respect allow / wait / block, and never overclaim what ORBIT observed.

Concepts

How ORBIT works

The model behind the product: deterministic authority at the tool boundary — allow, step-up, or deny, always with a receipt. Stable while screens evolve.

Getting started

First hour

Quickstart

Sign in or recover access, create an API key, install the hook, verify the approval path, and confirm a test escalation.

Install

Manual install

Install orbit-hook by hand, configure Claude Code hooks, run whoami, and test the approval path.

Using ORBIT day to day

Policy

Agent Policy

How default rules work, what is live versus target launch behavior, the Allow / Ask me first / Block verdicts, and how to draft policy edits safely.

Approvals

Approvals

What an approval alert looks like, how to decide, what happens on timeout, standing approvals (10M / 30M / 1H), and the approvals queue.

CI/CD

Deploy approval

Gate production deploys on ORBIT approval: request, policy, signed receipt, and CI-side verification before anything in your cloud changes. GitHub Actions today.

Receipts

Verifying receipts

What the .orbitproof file contains, web verification that is live today, planned offline CLI verification, receipt tiers, and what failed verification means.

When things go wrong

Recovery

Break-glass & recovery

Turn ORBIT off, restore your settings, or uninstall — locally, even if the service is unreachable. Governance is never a trap.

Fix it

Troubleshooting

Symptom-to-fix mappings for sign-in loops, install, approval alerts not arriving, hook not firing, lost API key, expected-block-was-allowed, offline-verify mismatch, and when to email support.

FAQ

FAQ

Frequently asked questions: what ORBIT sees, default policy, approval-alert timeout, privacy, receipts, bypass, uninstall, and how it differs from Claude Code permissions.