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 a new account to your first reviewed run, in six steps.
Core concepts
The words Peractor is built from, and how they fit together.
Peractor on your devices
Five surfaces over one account — browser, Mac, Windows and Linux, iPhone and iPad, Android.
Working offline
Open, edit and create files in Code with no connection; your edits wait on the device and merge when you're back.
The assistant
Ask in your own words; it does the work inside the scope you give it, and anything that can't be undone waits for your yes.
Peractor in your chat apps
Drive Peractor from Claude, ChatGPT, Codex, or Claude Code — doing only what you allow, and never more than you can.
Projects & tasks
Projects & repositories
What a project holds, how a repository binds to one, and where settings live.
Tasks & the board
The backlog: where work comes from, what a task holds, and how running it works.
Milestones, cycles & triage
Group work toward a date, run it in fixed-length iterations, and hold arrivals at the door.
Views, filters & bulk edits
Save the arrangement you work in, group and order it your way, and change many tasks at once.
Calendar
One calendar for every organization you belong to: deadlines, plans, events and the time you reserve for work.
Scheduling
A booking page on your calendar: people outside Peractor pick a free time, and it lands on your calendar with its call.
Calls
Zoom, Google Meet and Microsoft Teams calls on your events, and what comes back after them.
Every mailbox you have in one place, and a message one press from a task, a run or your calendar.
Chat
Your organization's own messenger: channels, direct messages and threads, with your agent teammates and your runs in the conversation.
Code: your repository, any branch
Browse any branch of the project's repository, open and edit any file, and commit — from every device.
Memory
What every agent should know about how your team works — written once, kept beside the code, approved by a person.
The project wiki
Your team's markdown files, readable and editable on every device — and still just files in your repo.
Workflows
Workflows
The pipeline a run follows: phases, gates, defaults, and the board automation that starts them.
Step reference
The fifteen step types, what each one is for, and every option they take.
Running workflows side by side
Fan a phase out into lanes, each running another workflow, then merge the results.
Instructions & categories
Standing guidance a step hands its agent, written once, and categories to group it in its libraries.
Agents & models
Choosing which coding agent and model does the work, per step, per workflow, or per project.
Skills & MCP servers
Two ways to equip every run at once: instructions the agent reads, and tools it can call.
Triggers
Start runs when nobody is watching — on a schedule, a repository event, an incoming webhook, mail arriving, a calendar event, a call that ended, or Peractor's own events: the board, milestones, gates, metrics, memory and your organization.
Review & collaborate
Gates & reviews
The checkpoint between phases: approve to advance, or send the work back with a note.
Code review
Review the actual diff line by line, from a browser, the desktop app, the Mac, or your phone.
Mid-run questions
Let an agent stop and ask you, instead of guessing on the expensive decisions.
Talking to a running step
Mark a step interactive and it waits when its prompt is done, so you can talk to the agent before it moves on.
Working in a run's shell
A terminal step stops a run for a person to work in its workspace from a shell, then carries on when they press Done.
Artifacts & previews
When a diff is not the best evidence: files the agent publishes, and the running result served live.
Notifications
Getting told the things that need you — in your team's channels, in the app, and on your phone.
Sharing
One link per run, task, workflow, instruction, trigger, and app — and a way to share things back in.
Trackers
Connect trackers
Sync issues from GitHub, Linear, Jira, GitLab, Notion, or Slack — as Peractor tasks, kept in step both ways.
GitHub Issues, Projects & pull requests
One app install, three different boards — issues, a Projects board, and a pull request inbox.
Linear
The richest status model of any connector, synced live.
Jira
Real statuses and real transitions, over OAuth.
GitLab
Issues over OAuth, with labels as the board — on gitlab.com or your own instance.
Notion
A database as a board, with you saying which property is which.
Slack as a task source
A message is a task, its thread is the activity log, and reactions are the board.
Runs & execution
The run lifecycle
What a run does, what its states mean, and the different ways to do it again.
Machines & isolation
Where phases actually execute, and the boundary around agent code that cannot be switched off.
Run on your own machine
Pair a Mac, Linux box, or Windows machine and send phases to it — no ports to open, no tunnel.
Git & credentials
How a run gets a branch, how it pushes, and where pull requests come from.
Apps
Marketplace
Administration
Accounts, organizations & members
How you sign in, how your team's shared space works, and who can do what.
Personas
Agent teammates you hand tasks to and talk to — each with its own guidance, workflows, role, budget and hours.
Roles & permissions
Who can do what in an organization: its owner, Everyone, and the roles you make.
Private projects & access
Keep a project, a folder or a file to the people who need it, and say what each role and person may do there.
Where files are kept
Keep a wiki, Assets or memory folder in the repository, in Peractor, or in a bucket or repository of your own — and move it when that changes.
Plans & usage
Four limits — runs at once, runs a month, seats, storage — and what happens when you reach each.
Public API
File work into Peractor from CI, a form, Zapier, or your own backend — with a key that may do only what you give it.
Self-hosting
Run the whole platform yourself with Docker Compose — the same product, on your own box.