Quickstart
Launch DorkOS and open your first Claude Code session in under two minutes.
Quickstart
From a fresh install to a running Claude Code session in the browser.
Prerequisites
- Node.js 18+ installed
- Claude Code CLI installed and authenticated (
claudeavailable in your PATH) - DorkOS installed — see the Installation guide
Launch DorkOS
Start the server
dorkosDorkOS starts on port 4242 by default and opens the web interface in your browser.
DorkOS v1.x.x
Local: http://localhost:4242 // [!code highlight]
Network: http://192.168.1.100:4242To use a different port or project directory:
dorkos --port 8080 --dir ~/projects/myappSend your first message
Type a message in the chat input and press Enter. Claude streams its response in real time.
Explain the structure of this projectApprove tool calls
When Claude needs to read files, run commands, or make edits, a tool approval card appears. Review the action and click Approve or Deny.
Always review tool calls before approving — especially write operations and shell commands.
Explore the Interface
The sidebar lists every conversation session across all your Claude Code clients — CLI, browser, and Obsidian all write to the same JSONL transcripts, so everything appears here. Each session entry shows the agent identity with color and icon, making it easy to see which project is active at a glance.
- Click a session to switch to it
- Click New Session to start fresh
- History persists across restarts
Type / in the chat input to open the command palette. Slash commands load from
.claude/commands/ in your working directory and inject predefined prompts or workflows into the
conversation.
DorkOS operates in a working directory, the same way the Claude Code CLI does. By default it uses
the directory where you ran dorkos. Use the directory picker in the sidebar to switch
without restarting.
CLI Quick Reference
| Flag | Short | Description | Default |
|---|---|---|---|
--port <port> | -p | Server port | 4242 |
--dir <path> | -d | Working directory | Current directory |
--boundary <path> | -b | Directory access boundary | Home directory |
--tunnel | -t | Enable ngrok tunnel | Off |
--log-level <level> | -l | Log verbosity (fatal through trace) | info |
Next Steps
Once installed, browse the Marketplace at /marketplace to discover pre-built agents, plugins, and skill packs from the community.
Marketplace
Install pre-built agents, plugins, and skill packs from the community.
Configuration
Customize ports, directories, and persistent settings.
Tool Approval
Configure permission modes — from approve-everything to fully autonomous.
Task Scheduler
Schedule agents to run on a cron, independently of your terminal.
Relay Messaging
Connect agents to Telegram, webhooks, and each other.