Documentation
Everything you need to put agents on rails — from first sign-in to multi-tracker backlogs, custom approver policies, and running the whole platform yourself.
Start here
Getting started
From zero to your first gated run: create an org, connect your editor, and watch an agent work.
Core concepts
The dozen words Peractor is built from, and how they fit together.
The Peractor apps
Editor, dashboard, desktop, and phones — what each surface is for.
Projects & tasks
Projects & repositories
The workspace tier: binding a repo, where configuration lives, and the project system prompt.
Tasks & the board
The backlog: manual and imported tasks, your own statuses and priorities, and running work from a card.
Workflows
Workflows
Declarative, versioned pipelines: phases, gates, defaults, and the status automation that drives them from the board.
Step reference
All eight step types — prompt, check, command, git, notify, publish, preview, loop — with every field.
Personas & categories
Reusable agent identities injected as system prompts, and the optional folders that organize both libraries.
Agents & models
Claude and Codex, the model catalog, reasoning effort, and where credentials live.
Review & collaborate
Gates & reviews
Human-in-the-loop by default: approvals, rework loops, and who's allowed to approve.
Code review in the editor
Review the run's branch with native diffs and inline comments — submitted as one rework, whenever you like.
Mid-run questions
Let the agent pause and ask instead of guessing — the run waits, you answer, the same session continues.
Artifacts & previews
Reviewable deliverables: screenshots and documents the agent publishes, and live previews served from the sandbox.
Notifications
Run milestones where your team already looks — seven chat notifiers plus native push on the phones.
Trackers
Connect trackers
One backlog over GitHub, Linear, Jira, GitLab, Notion, and Slack — synced both ways, statuses kept native.
GitHub Issues & Projects
One App install, two trackers: repository issues, and Projects boards with real columns.
Linear
Workspace app install, project-level imports, and Linear's real workflow states.
Jira
OAuth connection to one Jira Cloud site; projects import with their real workflow statuses.
GitLab
OAuth tracker where labels are the board: status changes swap labels, closing an issue retires its task.
Notion
Any database becomes a backlog — you choose which properties mean status, assignee, and labels.
Slack as a task source
Messages become tasks, reactions become status, and the thread is the activity log.
Runs & execution
The run lifecycle
Every state a run can be in, what the live session shows, and what cancel, start over, and rework each do.
Runners & isolation
Where agent code executes: the mandatory sandbox, remote runners with labels, and the warm workspace cache.
Git & credentials
Branches carry the work: naming, PR steps, and how runs get permission to push.
Administration
Organizations & members
Accounts, organizations, the two roles, and how to invite your team.
Plans & usage
What each plan includes, and exactly how the two run limits behave.
Public API
Register tasks and start runs from any system with an organization API key.
Self-hosting
Run the whole platform yourself with Docker Compose — the same MIT-licensed product as Peractor Cloud.