@meshwhisper/cli 0.2.0 → 0.2.1
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 +45 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# @meshwhisper/cli
|
|
2
|
+
|
|
3
|
+
Developer tooling for [MeshWhisper](https://github.com/twotwoonethree/meshwhisper) — the self-hostable, end-to-end encrypted messaging SDK and relay.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npx @meshwhisper/cli init
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
## Commands
|
|
10
|
+
|
|
11
|
+
### `init`
|
|
12
|
+
|
|
13
|
+
Scaffolds a MeshWhisper project in the current directory. Asks for your namespace, where your app should connect (Foundation relay for development, self-hosted for production), and what kind of app you're building. Writes:
|
|
14
|
+
|
|
15
|
+
- **`meshwhisper-node/`** (self-hosted only) — a complete server deployment: `docker-compose.yml`, standalone Dockerfiles that install the published `@meshwhisper/node` and `@meshwhisper/push-service` packages, a `.env` (mode 600) with generated Web Push VAPID keys, and a `federation-peers.json` bootstrapped against the Foundation relay so your node can join the open relay mesh
|
|
16
|
+
- **`src/meshwhisper.ts`** (browser/PWA) or **`meshwhisper-chat.mts`** (Node.js) — a working SDK skeleton with your namespace and node URL threaded in
|
|
17
|
+
- **`.gitignore`** entries for the `.env` and local identity stores
|
|
18
|
+
|
|
19
|
+
Idempotent: existing files are never overwritten.
|
|
20
|
+
|
|
21
|
+
### `doctor [url]`
|
|
22
|
+
|
|
23
|
+
Health-checks a MeshWhisper node (defaults to the Foundation relay):
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npx @meshwhisper/cli doctor wss://relay.myapp.com
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Prints the `/health` snapshot — connected clients, stored blobs, prekey entries, federation status.
|
|
30
|
+
|
|
31
|
+
### `vapid`
|
|
32
|
+
|
|
33
|
+
Generates a Web Push VAPID key pair (RFC 8292) with no dependencies — byte-identical output format to `web-push generate-vapid-keys`:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
npx @meshwhisper/cli vapid
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Documentation
|
|
40
|
+
|
|
41
|
+
- [Getting started](https://github.com/twotwoonethree/meshwhisper/blob/main/docs/getting-started.md)
|
|
42
|
+
- [Self-hosting guide](https://github.com/twotwoonethree/meshwhisper/blob/main/docs/self-hosting.md)
|
|
43
|
+
- [Federation](https://github.com/twotwoonethree/meshwhisper/blob/main/docs/federation.md)
|
|
44
|
+
|
|
45
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@meshwhisper/cli",
|
|
3
|
-
"version": "0.2.
|
|
4
|
-
"description": "MeshWhisper CLI
|
|
3
|
+
"version": "0.2.1",
|
|
4
|
+
"description": "MeshWhisper CLI — developer tooling for MeshWhisper projects",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
7
7
|
"meshwhisper": "dist/index.js"
|