dorkos 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/README.md +39 -47
  2. package/dist/bin/cli.js +16825 -26
  3. package/dist/client/assets/{code-block-37QAKDTI-lJVmOB7p.js → code-block-37QAKDTI-D1V_F2_H.js} +1 -1
  4. package/dist/client/assets/index-3iyMhyiM.css +1 -0
  5. package/dist/client/assets/index-yeKWoOws.js +476 -0
  6. package/dist/client/index.html +9 -8
  7. package/dist/server/index.js +3570 -1070
  8. package/dist/server/index.js.map +4 -4
  9. package/package.json +3 -1
  10. package/dist/client/.gitkeep +0 -0
  11. package/dist/client/assets/index-CkhDDYrb.js +0 -476
  12. package/dist/client/assets/index-yeRKxnbi.css +0 -1
package/README.md CHANGED
@@ -1,18 +1,15 @@
1
1
  # dorkos
2
2
 
3
- Web-based interface and REST/SSE API for [Claude Code](https://docs.anthropic.com/en/docs/claude-code), built with the [Claude Agent SDK](https://www.npmjs.com/package/@anthropic-ai/claude-agent-sdk).
3
+ [![npm version](https://img.shields.io/npm/v/dorkos)](https://www.npmjs.com/package/dorkos)
4
+ [![license](https://img.shields.io/npm/l/dorkos)](https://github.com/dork-labs/dorkos/blob/main/LICENSE)
4
5
 
5
- Provides a chat UI for interacting with Claude Code sessions, with tool approval flows, slash command discovery, and real-time session sync across multiple clients.
6
+ Web-based interface and REST/SSE API for Claude Code, built with the Claude Agent SDK.
6
7
 
7
- ## Prerequisites
8
+ ## What is DorkOS?
8
9
 
9
- - **Node.js** >= 18
10
- - **Claude Code CLI** installed and available in your PATH:
11
- ```bash
12
- npm install -g @anthropic-ai/claude-code
13
- ```
10
+ DorkOS provides a browser-based chat UI for interacting with Claude Code sessions. It includes tool approval flows, slash command discovery, cross-client session sync, and a full REST/SSE API — all powered by the Claude Agent SDK.
14
11
 
15
- ## Install
12
+ ## Installation
16
13
 
17
14
  ```bash
18
15
  npm install -g dorkos
@@ -21,58 +18,53 @@ npm install -g dorkos
21
18
  ## Usage
22
19
 
23
20
  ```bash
24
- # Start DorkOS (opens on http://localhost:6942)
25
21
  dorkos
22
+ ```
26
23
 
27
- # Custom port
28
- dorkos --port 8080
24
+ The server starts on port 4242 and opens your browser automatically. You'll see the DorkOS chat interface where you can start Claude Code sessions, approve tool calls, and use slash commands.
29
25
 
30
- # Set working directory
31
- dorkos --dir ~/projects/myapp
26
+ ## Configuration
32
27
 
33
- # Enable ngrok tunnel for remote access
34
- NGROK_AUTHTOKEN=your_token dorkos --tunnel
35
- ```
28
+ ### Required
29
+
30
+ | Variable | Description |
31
+ |---|---|
32
+ | `ANTHROPIC_API_KEY` | Your Anthropic API key |
33
+
34
+ ### Optional
36
35
 
37
- ## Options
36
+ | Variable | Default | Description |
37
+ |---|---|---|
38
+ | `DORKOS_PORT` | `4242` | Server port |
39
+ | `DORKOS_DEFAULT_CWD` | Current directory | Default working directory for sessions |
40
+ | `DORKOS_BOUNDARY` | Home directory | Directory boundary root (restricts filesystem access) |
41
+ | `LOG_LEVEL` | `info` | Log verbosity (`fatal`, `error`, `warn`, `info`, `debug`, `trace`) |
38
42
 
39
- | Flag | Short | Description | Default |
40
- |------|-------|-------------|---------|
41
- | `--port <port>` | `-p` | Port to listen on | `6942` |
42
- | `--tunnel` | `-t` | Enable ngrok tunnel | `false` |
43
- | `--dir <path>` | `-d` | Working directory | Current directory |
44
- | `--help` | `-h` | Show help message | |
45
- | `--version` | `-v` | Show version number | |
43
+ ### Tunnel Configuration
46
44
 
47
- ## Environment Variables
45
+ DorkOS supports ngrok tunnels for remote access:
48
46
 
49
47
  | Variable | Description |
50
- |----------|-------------|
51
- | `NGROK_AUTHTOKEN` | ngrok auth token (required for `--tunnel`) |
52
- | `TUNNEL_AUTH` | HTTP basic auth for tunnel (`user:pass`) |
53
- | `TUNNEL_DOMAIN` | Custom ngrok domain |
48
+ |---|---|
49
+ | `TUNNEL_ENABLED` | Set to `true` to enable ngrok tunnel |
50
+ | `NGROK_AUTHTOKEN` | Your ngrok authentication token |
51
+ | `TUNNEL_DOMAIN` | Custom tunnel domain (optional) |
52
+ | `TUNNEL_AUTH` | Basic auth in `user:pass` format (optional) |
53
+
54
+ ## Config Directory
54
55
 
55
- ## Features
56
+ DorkOS creates a `~/.dork/` directory on startup for configuration storage. Log files are written to `~/.dork/logs/dorkos.log` as NDJSON.
56
57
 
57
- - Chat UI for Claude Code with rich markdown rendering
58
- - Tool approval/deny flow for safe AI interactions
59
- - Slash command discovery from `.claude/commands/`
60
- - SSE streaming for real-time responses
61
- - Session sync across multiple clients (including CLI)
62
- - REST API with OpenAPI docs at `/api/docs`
58
+ ## API Documentation
63
59
 
64
- ## API
60
+ When running, DorkOS serves interactive API documentation at `/api/docs` (powered by Scalar UI) and the raw OpenAPI spec at `/api/openapi.json`.
65
61
 
66
- Once running, DorkOS exposes:
62
+ ## Links
67
63
 
68
- - **`GET /api/sessions`** - List all sessions
69
- - **`POST /api/sessions`** - Create a new session
70
- - **`GET /api/sessions/:id/messages`** - Get message history
71
- - **`POST /api/sessions/:id/messages`** - Send a message (SSE stream)
72
- - **`GET /api/sessions/:id/stream`** - Subscribe to session changes (SSE)
73
- - **`GET /api/docs`** - Interactive API documentation (Scalar)
74
- - **`GET /api/openapi.json`** - OpenAPI specification
64
+ - [Documentation](https://github.com/dork-labs/dorkos/tree/main/docs)
65
+ - [GitHub](https://github.com/dork-labs/dorkos)
66
+ - [Issues](https://github.com/dork-labs/dorkos/issues)
75
67
 
76
68
  ## License
77
69
 
78
- MIT
70
+ [MIT](https://github.com/dork-labs/dorkos/blob/main/LICENSE)