Skip to content
Back to home

Product documentation

Start with one agent. Finish with a team.

A direct guide to installing Orkestrai, building your canvas, and shipping work with agents that share context.

01 / 09

Installation

Download the latest release for macOS, Windows, or Linux. The desktop app includes the server and runtimes required to operate the canvas.

  • Install at least one supported CLI: Claude Code, Codex, Kimi Code, OpenCode, Cursor, Antigravity, Cline, or Devin.
  • On macOS, use version 0.1.4 or newer: it is signed with Developer ID and notarized by Apple, so it opens normally through Finder after being copied to Applications.
  • Keep Git available for history, diff, and floor features.
  • Local voice models are optional and download only after your confirmation.
02 / 09

Your first workspace

A workspace points to a real project folder. Orkestrai keeps visual configuration separate and provisions the local bridge agents use to operate the canvas.

Step by step
  1. 1Create a workspace and select the project folder.
  2. 2Open Agents, choose any available service, and pin up to four favorites when you want direct toolbar access.
  3. 3Mark one agent as leader to enable team orchestration.
  4. 4Describe the desired outcome; the leader can recruit specialists and distribute tasks.
03 / 09

Canvas and connections

The canvas brings together real PTY terminals, notes, tasks, workflows, images, portals, and files. Connections represent actual collaboration and show activity when agents talk.

  • Connect notes and images to their owners to make context explicit.
  • Assign work through the kanban; each task goes directly to the chosen terminal.
  • Open Portals to view and test local applications without leaving the workspace.
  • Use Cmd/Ctrl+K to search the in-app documentation.
04 / 09

Workbench and editor

Workbench turns the same workspace into a focused desktop surface. Its explorer opens agents, tasks, notes, portals, mobile devices, and workspace files in up to eight resizable panes.

  • Choose vertical or horizontal tabs and split any pane to the right or below.
  • Edit workspace files in Monaco with persistent models, find and replace, symbols, formatting, and protected dirty buffers.
  • Open Markdown, PDF, image, and binary previews without creating disconnected canvas nodes.
  • Use Cmd/Ctrl+K to search files, content, agents, tasks, tools, settings, and commands.
05 / 09

Leader and Orkestrai bridge

The leader coordinates the team through the orkestrai CLI and MCP tools provisioned in the workspace. It can talk to agents, write notes, create tasks, open portals, and organize floors.

orkestrai list
orkestrai ask Frontend "Implement the screen from the spec note"
orkestrai task add "Review responsiveness" --assign Reviewer
orkestrai notify "Delivery ready for review"
06 / 09

Workflows and parallel work

Workflows chain agents, human approvals, and reusable outputs. Floors use git worktrees to isolate parallel efforts and preview diffs and conflicts before landing on the main branch.

  • Sync a workflow with its connections to turn the drawing into a pipeline.
  • See each task title, stage, and assignee for ground and every worktree.
  • Create one floor per feature when teams need to change the same project in parallel.
  • Review the preview before landing; conflicts are never resolved silently.
07 / 09

Dictation and spoken replies

Dictation uses Parakeet and replies use Supertonic 3, both locally. Presets are available for Brazilian Portuguese, US English, and Latin American Spanish.

  • Focus any task, role, note, or form field and use the global orb to insert dictation at the cursor.
  • Optionally submit terminal dictation with Enter; regular text fields remain insert-only.
  • With no active field on the canvas, the orb sends the transcript to the leader.
  • Choose a voice and set speed from 0.75x to 1.50x in Settings.
  • The first download requires confirmation; processing then stays on-device.
08 / 09

Operations and continuity

Workspaces keep running in the background. Resumable sessions preserve each terminal conversation, while native notifications distinguish task completion, project completion, and required attention.

  • Change an agent provider in place while preserving its role, floor, and connections.
  • Pin Usage to the canvas and let the leader consult its source, fallback, monitored window, and threshold before assigning new work.
  • Ports lists only listeners tied to local Portals in the current workspace.
  • Choose a built-in light or dark theme, or edit and share validated semantic color tokens.
  • Canvas data, sessions, and local models remain on your machine.
09 / 09

Decisions, automation, devices, and sharing

Control Center and Review Center make activity and delivery evidence explicit. Council, Automations, Mobile Device, and encrypted workspace sharing extend the same traceable operating model.

  • Ask two to five agents for independent Council perspectives, then keep the final selection human.
  • Run idempotent automations from schedules, tasks, messages, Git events, webhooks, file changes, or usage limits.
  • Control iOS Simulator and Android emulators or approved physical devices from Canvas and Workbench.
  • Choose a browser/mobile or installed-app invitation, approve the exact device and role, and follow the sanitized workspace projection in the installable Remote PWA.
  • Operators can hold a traceable agent conversation. Administrators can start or restore agents, while raw terminal control requires a separate per-device switch that is disabled by default and audited.