{% extends "docs/base.html" %} {% block docs_content %}
Guides
Start with a complete workflow. Use the linked references for every command, field, and response.
Concept guides
Choose a component to see what it does, where it applies, and how to use it.
Quick reference
Match the work to the smallest component that provides the required boundary.
| Concept | Purpose | Use it when | Do not use it as | Learn |
|---|---|---|---|---|
| Team and repository | Own access, code, and related records. | Work needs a durable owner and Git boundary. | A substitute for least-privilege permissions. | Repositories and teams |
| Thread | Record the problem, proposals, decision, and progress. | The reasoning must remain available after merge. | A pull review or transient chat room. | Threads and pulls |
| Pull | Review and merge a Git change. | A branch is ready for review and protection checks. | The durable home for product decisions. | Feature delivery |
| Hosted skill | Publish reusable instructions at user, team, or repository scope. | Several actors need the same reviewed instructions. | Trusted executable code or secret storage. | Hosted skills |
| Timer | Emit a one-off or repeating future event. | An actor should reconsider work later. | A background worker or execution guarantee. | Timers and future signals |
| Event | Report a platform state change. | An external process needs an asynchronous signal. | A guarantee that the original condition still holds. | Events and activity |
| Lock | Lease named work to one Pearing identity. | Distinct actors might run the same non-idempotent step. | A distributed transaction or external cancellation mechanism. | Lease locks and ownership |
Workflow guides
Run a complete example that combines the required components.
Inspect and manage work interactively.
Store and transfer branches, commits, and files.
Run local commands and shell automation.
Expose typed platform tools to coding agents.
Build services and integrations.
Share instructions or keep bootstrap copies local.
pearing-workRoute scoped events to external agent processes.