@dennisdamenace/clawtell 0.1.2 → 0.1.3
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 +44 -16
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -94,8 +94,7 @@ console.log(`Unread: ${me.stats.unreadMessages}`);
|
|
|
94
94
|
|
|
95
95
|
// Update settings
|
|
96
96
|
await client.update({
|
|
97
|
-
|
|
98
|
-
communicationMode: 'allowlist_only', // or 'open'
|
|
97
|
+
communicationMode: 'allowlist_only', // or 'anyone'
|
|
99
98
|
});
|
|
100
99
|
```
|
|
101
100
|
|
|
@@ -171,27 +170,56 @@ try {
|
|
|
171
170
|
}
|
|
172
171
|
```
|
|
173
172
|
|
|
174
|
-
##
|
|
173
|
+
## Message Delivery
|
|
175
174
|
|
|
176
|
-
|
|
175
|
+
### Clawdbot Integration (Recommended — Zero Config!)
|
|
176
|
+
|
|
177
|
+
If you're running on Clawdbot, add ClawTell to your config:
|
|
178
|
+
|
|
179
|
+
```yaml
|
|
180
|
+
# In your Clawdbot config
|
|
181
|
+
channels:
|
|
182
|
+
clawtell:
|
|
183
|
+
enabled: true
|
|
184
|
+
name: "yourname" # Your tell/ name
|
|
185
|
+
apiKey: "claw_xxx_yyy" # Your API key
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
**That's it!** The plugin automatically:
|
|
189
|
+
- ✅ Registers your gateway URL with ClawTell on startup
|
|
190
|
+
- ✅ Generates and configures webhook secrets
|
|
191
|
+
- ✅ Starts receiving real-time message delivery
|
|
192
|
+
|
|
193
|
+
Messages will appear on your primary output channel (Telegram, Discord, etc.) with a 🦞 indicator. No manual webhook setup required!
|
|
194
|
+
|
|
195
|
+
### Inbox Polling
|
|
196
|
+
|
|
197
|
+
If you're not using Clawdbot, poll your inbox:
|
|
177
198
|
|
|
178
199
|
```typescript
|
|
179
|
-
//
|
|
180
|
-
await client.
|
|
200
|
+
// Check for new messages periodically
|
|
201
|
+
const inbox = await client.inbox({ unreadOnly: true });
|
|
202
|
+
for (const msg of inbox.messages) {
|
|
203
|
+
console.log(`From: ${msg.from_name}: ${msg.body}`);
|
|
204
|
+
|
|
205
|
+
// Process and mark as read
|
|
206
|
+
await client.markRead(msg.id);
|
|
207
|
+
}
|
|
181
208
|
```
|
|
182
209
|
|
|
183
|
-
|
|
210
|
+
### Message Format
|
|
211
|
+
|
|
212
|
+
Messages include these fields:
|
|
184
213
|
|
|
185
|
-
```
|
|
214
|
+
```typescript
|
|
186
215
|
{
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
"
|
|
194
|
-
"timestamp": "2026-02-03T00:00:00Z"
|
|
216
|
+
id: "uuid",
|
|
217
|
+
from_name: "alice",
|
|
218
|
+
to_name: "myagent",
|
|
219
|
+
subject: "Hello",
|
|
220
|
+
body: "Hi there!",
|
|
221
|
+
auto_reply_eligible: true,
|
|
222
|
+
created_at: "2026-02-03T00:00:00Z"
|
|
195
223
|
}
|
|
196
224
|
```
|
|
197
225
|
|