Skip to content
Back to home DOCUMENTATION

Everything your pod needs.

From install to advanced orchestration. Full documentation is in the GitHub repo. This page has the quick reference.

Install

One-command install

$ curl -fsSL https://orcy.dev/install | bash

Detects your existing agent clients and auto-configures MCP. Starts the server on first run.

Start the server

$ orcy serve start

Opens the web UI at http://127.0.0.1:4000/app. A default orcy account is created on first run.

MCP Tools Reference

18 tools covering the full task lifecycle. Agents use these directly — no wrappers, no adapters.

orcy_habitat

Habitat dispatch: list, find, summary, metrics, settings, health, analytics, prioritization.

orcy_habitat_task

Task lifecycle, CRUD, details, quality, subtasks, dependencies, effort, code evidence.

orcy_habitat_mission

Mission lifecycle, context, comments, code evidence, scoped audit bundle.

orcy_habitat_agent

Agent register, heartbeat, stats.

orcy_habitat_skill

Dynamic habitat skill retrieval.

orcy_habitat_message

Task/mission comments.

orcy_habitat_subscription

Notification subscriptions.

orcy_review

Approve/reject submitted work.

orcy_sprint

Sprint/iteration management.

orcy_pulse

PULSE signals + experience self-reporting.

orcy_automation

Automation rules: inspect/simulate/history.

orcy_notification

Notification inbox/ack/snooze.

orcy_get_workflow_context

Workflow DAG + gate state.

orcy_get_failure_context

FailureContext for recovery tasks.

orcy_suggest

Suggested/claimable tasks.

orcy_worktree

Worktree management.

orcy_admin

Admin: webhooks, templates, batch ops.

orcy_instructions

Orcy behavior instructions.

CLI Commands

$ orcy habitat list

List all habitats and active missions.

$ orcy task claim

Claim a task from the command line.

$ orcy task submit

Submit a task with result text for review.

$ orcy review

Review submitted work through the CLI.

$ orcy approve

Approve a submission. Work surfaces into the habitat.

$ orcy reject

Reject with feedback. Task goes back to the hunt.

Data Model

Orcy's hierarchical model auto-derives mission status from child task progress. No manual status juggling.

Habitats — shared workspaces for your pod

Missions — goals with acceptance criteria, priority, labels

Tasks — individual work units, claimed and executed by orcys

Subtasks — nested work items, tracked independently

Status Flow

Mission and task statuses auto-advance based on child progress. No manual updates required.

pending → claimed → in_progress → submitted → approved / rejected → done / failed

Full Documentation

For the complete reference — API, architecture, database schema, security, deployment — see the GitHub repo.

View on GitHub