@delt/claude-alarm 0.1.5 → 0.1.6
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.
- package/README.md +21 -18
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@ Claude Code ──reply/notify──> [Channel Server] ──> [Hub Server]
|
|
|
11
11
|
## Features
|
|
12
12
|
|
|
13
13
|
- **Web Dashboard** — Monitor all Claude Code sessions in one place
|
|
14
|
-
- **Two-way Messaging** — Send messages to Claude and receive replies
|
|
14
|
+
- **Two-way Messaging** — Send messages to Claude and receive replies (with markdown rendering)
|
|
15
15
|
- **Desktop Notifications** — Get Windows/macOS/Linux toast notifications
|
|
16
16
|
- **Session Status** — See which sessions are idle, working, or waiting for input
|
|
17
17
|
- **Token Auth** — Secure hub access with auto-generated tokens
|
|
@@ -19,43 +19,46 @@ Claude Code ──reply/notify──> [Channel Server] ──> [Hub Server]
|
|
|
19
19
|
|
|
20
20
|
## Quick Start
|
|
21
21
|
|
|
22
|
-
### 1. Install
|
|
22
|
+
### 1. Install & Initialize
|
|
23
|
+
|
|
24
|
+
In your project directory:
|
|
23
25
|
|
|
24
26
|
```bash
|
|
25
|
-
|
|
27
|
+
npx @delt/claude-alarm init
|
|
26
28
|
```
|
|
27
29
|
|
|
30
|
+
This creates `.mcp.json` with the claude-alarm channel server config.
|
|
31
|
+
|
|
28
32
|
### 2. Start the Hub
|
|
29
33
|
|
|
30
34
|
```bash
|
|
31
|
-
claude-alarm hub start
|
|
35
|
+
npx @delt/claude-alarm hub start
|
|
32
36
|
```
|
|
33
37
|
|
|
34
|
-
This starts the hub server
|
|
35
|
-
|
|
36
|
-
### 3. Setup a Project
|
|
38
|
+
This starts the hub server and prints your auth token.
|
|
37
39
|
|
|
38
|
-
|
|
40
|
+
### 3. Run Claude Code
|
|
39
41
|
|
|
40
42
|
```bash
|
|
41
|
-
claude-alarm
|
|
43
|
+
claude --dangerously-load-development-channels server:claude-alarm
|
|
42
44
|
```
|
|
43
45
|
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
### 4. Run Claude Code
|
|
46
|
+
To allow remote control without approval prompts:
|
|
47
47
|
|
|
48
48
|
```bash
|
|
49
|
-
claude --dangerously-load-development-channels server:claude-alarm
|
|
49
|
+
claude --dangerously-load-development-channels server:claude-alarm --dangerously-skip-permissions
|
|
50
50
|
```
|
|
51
51
|
|
|
52
|
-
|
|
52
|
+
> **WARNING:** `--dangerously-skip-permissions` allows Claude to execute any action without your approval. Only use in trusted, isolated environments.
|
|
53
|
+
|
|
54
|
+
### 4. Open Dashboard
|
|
53
55
|
|
|
54
56
|
Open `http://127.0.0.1:7890` in your browser.
|
|
55
57
|
|
|
56
58
|
## CLI Commands
|
|
57
59
|
|
|
58
60
|
```
|
|
61
|
+
claude-alarm init Setup everything and show next steps
|
|
59
62
|
claude-alarm hub start [-d] Start the hub server (-d for daemon mode)
|
|
60
63
|
claude-alarm hub stop Stop the hub daemon
|
|
61
64
|
claude-alarm hub status Show hub status
|
|
@@ -101,14 +104,14 @@ Config is stored at `~/.claude-alarm/config.json`:
|
|
|
101
104
|
|
|
102
105
|
### Custom Session Names
|
|
103
106
|
|
|
104
|
-
The `.mcp.json` created by `claude-alarm
|
|
107
|
+
The `.mcp.json` created by `claude-alarm init` automatically uses the project directory name as the session name. You can customize it:
|
|
105
108
|
|
|
106
109
|
```json
|
|
107
110
|
{
|
|
108
111
|
"mcpServers": {
|
|
109
112
|
"claude-alarm": {
|
|
110
113
|
"command": "npx",
|
|
111
|
-
"args": ["-y", "claude-alarm"],
|
|
114
|
+
"args": ["-y", "@delt/claude-alarm", "serve"],
|
|
112
115
|
"env": {
|
|
113
116
|
"CLAUDE_ALARM_SESSION_NAME": "my-project"
|
|
114
117
|
}
|
|
@@ -138,14 +141,14 @@ To access the hub from another machine:
|
|
|
138
141
|
|
|
139
142
|
1. Set host to `0.0.0.0` in `~/.claude-alarm/config.json`
|
|
140
143
|
2. Open port 7890 in your firewall
|
|
141
|
-
3. On the remote machine,
|
|
144
|
+
3. On the remote machine, run `claude-alarm init` and select remote hub (Y), or manually set `.mcp.json`:
|
|
142
145
|
|
|
143
146
|
```json
|
|
144
147
|
{
|
|
145
148
|
"mcpServers": {
|
|
146
149
|
"claude-alarm": {
|
|
147
150
|
"command": "npx",
|
|
148
|
-
"args": ["-y", "claude-alarm"],
|
|
151
|
+
"args": ["-y", "@delt/claude-alarm", "serve"],
|
|
149
152
|
"env": {
|
|
150
153
|
"CLAUDE_ALARM_HUB_HOST": "your-server-ip",
|
|
151
154
|
"CLAUDE_ALARM_HUB_PORT": "7890",
|