# Record

Record is a desktop screen-recording CLI and video review platform for AI agent runs.

Primary documentation:
- /docs — product and workflow overview
- /docs/agents — connect an agent and make the first recording
- /docs/reviewers — playback, timestamped feedback, approval, and sharing
- /docs/cli — CLI installation and task-oriented examples
- /docs/billing — local vs cloud storage, plans, limits, and payment lifecycle
- /docs/security — credential boundaries and data handling
- /agent/SKILL.md — machine-readable agent onboarding

Core CLI flows:
- `record-cli doctor --json`
- `record-cli upgrade --check --json`
- `record-cli start --duration <seconds> --title <title> --agent <name> --json`
- `record-cli stop --publish --json`
- `record-cli run --title <title> -- <command>`
- `record-cli inbox --json`
- `record-cli share <recording-id> [--permissions view,comment,review] [--expires 7d]`

Agents should use named scoped `rec_pat_…` credentials and must never request an administrator workspace token when scoped access is available.

`record-cli upgrade --check --json` is read-only. Run `record-cli upgrade --json` only when the human requests an update or the task explicitly requires the current release; the updater verifies same-origin release metadata and the package SHA-256 before installation.

Local capture is unlimited. Cloud Free includes 10 GB and two connected agents. If an upload returns `WORKSPACE_QUOTA_EXCEEDED` or `CLOUD_READ_ONLY`, preserve the local file and report its `localPath`, usage details, and `upgradeUrl`.