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 22+ installed.
- Claude Code authenticated. DorkOS bundles the Claude Code binary, so installing it separately is optional. (A
claudebinary on your PATH is only used as a fallback.) - 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:4242If your browser doesn't open on its own (common over SSH or on a headless machine), copy the Local URL into any browser. See Troubleshooting if the page still won't load.
To 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, the same way you'd review a coworker's first pull request.
Always review tool calls before approving, especially write operations and shell commands.
Explore the Interface
DorkOS works out of a working directory, the folder on your computer it reads and edits in. By
default that's the folder you ran dorkos from. Use the directory picker in the sidebar to
switch to a different project without restarting.
The sidebar lists every conversation session across your Claude Code clients. Each entry shows the agent's identity with a color and icon, so you're not squinting at ten identical-looking tabs.
- Click a session to switch to it.
- Click New Session to start fresh.
- History persists across restarts.
If you also use the Obsidian plugin, note that it's an early, still-hardening surface. It reads from the same session history, but expect rough edges.
Type / in the chat input to open the command palette. Slash commands load from
.claude/commands/ in your working directory (see above) and inject predefined prompts or
workflows into the conversation.
CLI Quick Reference
Most people never touch these flags after the first launch. Here they are if you need them; see Configuration for the matching environment variables and persistent settings.
| Flag | Short | Description | Default |
|---|---|---|---|
--port <port> | -p | Server port | 4242 |
--dir <path> | -d | Working directory | Current directory |
--boundary <path> | -b | Boundary: the folders on your computer DorkOS is allowed to touch | Home directory |
--tunnel | -t | Enable ngrok tunnel | Off |
--no-open | Don't open the browser on startup | Off (opens browser) | |
--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.