DorkOS Documentation
The operating system for autonomous AI agents — scheduling, communication, and coordination.
DorkOS
The operating system for autonomous AI agents. DorkOS gives Claude Code a scheduling engine, a messaging layer, and a discoverable agent network — so your agents can work independently, reach you when they need to, and coordinate across projects.
Built on the Claude Agent SDK. Open source. Runs on your machine.
Get Started
Installation
Install via npm, Homebrew, Obsidian plugin, or clone for self-hosting.
Quickstart
Launch DorkOS and open your first session in under two minutes.
Configuration
Environment variables, config file, and CLI flags.
Guides
Task-oriented walkthroughs for common workflows.
CLI Usage
Flags, subcommands, and config management from the terminal.
Obsidian Plugin
Run DorkOS as an Obsidian sidebar panel — query agents without leaving your notes.
Tool Approval
Configure tool approval flows and permission modes.
Slash Commands
Discover and create custom slash commands from .claude/commands/.
Tunnel Setup
Access DorkOS from any device via ngrok tunnel.
Keyboard Shortcuts
Navigate the interface with hotkeys.
Task Scheduler
Schedule agents on a cron — independently, not tied to your terminal.
Relay Messaging
Connect agents to Telegram, webhooks, and each other.
Relay Observability
Track message delivery, inspect traces, and debug failures.
Agent Discovery
Register, discover, and monitor agents with Mesh.
Agent Coordination
Patterns for coordinating multiple agents with Relay, Mesh, and Tasks.
Agent Identity
Give your projects a name, color, and icon — think in agents, not file paths.
Persona Injection
Shape Claude's behavior per-project with custom system prompt context.
Building Relay Adapters
Create custom adapters to connect agents to any external channel.
Concepts
How DorkOS works under the hood.
Architecture
How DorkOS connects to Claude Code via the Agent SDK.
Sessions
The JSONL-based session model and multi-client visibility.
Transport
The Transport abstraction that decouples UI from backend.
Relay
Subject-based messaging between agents and external channels.
Mesh
Agent discovery, registry, and network topology.
Integrations
Build custom clients or connect DorkOS to your workflow.
Building Integrations
Use the Transport interface or REST API to build custom clients.
SSE Protocol
Wire format, event types, and connection lifecycle.
API Reference
Interactive OpenAPI documentation for all endpoints.
Self-Hosting
Run DorkOS on your own machine or server.
Deployment
Build, configure, and run DorkOS in production.
Reverse Proxy
nginx and Caddy configs with SSE support.