DorkOS Documentation
Web-based interface and REST/SSE API for Claude Code
DorkOS
A web-based chat interface and REST/SSE API for Claude Code, built on the Claude Agent SDK.
DorkOS gives you a browser UI for Claude Code sessions — with real-time streaming, tool approval flows, slash command discovery, and multi-client sync. Use it standalone via npm, embed it in Obsidian, or build your own client against the API.
Get Started
Installation
Install via npm, Obsidian, or clone for self-hosting.
Quickstart
Go from zero to your first Claude Code conversation in 5 minutes.
Configuration
Environment variables, config file, and CLI flags.
Guides
Task-oriented walkthroughs for common workflows.
CLI Usage
Command-line flags, subcommands, and config management.
Obsidian Plugin
Use DorkOS as an Obsidian sidebar panel.
Tool Approval
Understand and configure tool approval flows.
Slash Commands
Discover and create custom slash commands.
Tunnel Setup
Access DorkOS remotely via ngrok tunnels.
Keyboard Shortcuts
Navigate the UI efficiently with hotkeys.
Relay Messaging
Send messages between agents via subject-based pub/sub.
Agent Discovery
Register, discover, and monitor agents with Mesh.
Pulse Scheduler
Autonomous cron-based agent jobs.
Concepts
Understand 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
The subject-based pub/sub message bus architecture.
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.
Building Relay Adapters
Create custom adapters for external channels.
API Reference
Interactive OpenAPI documentation for all endpoints.
Self-Hosting
Run DorkOS on your own infrastructure.
Deployment
Build, configure, and run DorkOS in production.
Reverse Proxy
nginx and Caddy configs with SSE support.
Contributing
Help improve DorkOS.