wispctl 1.0.7 → 1.0.9
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 +90 -6
- package/dist/index.js +46364 -42448
- package/dist/index.js.map +100 -78
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -1,15 +1,99 @@
|
|
|
1
|
-
#
|
|
1
|
+
# wispctl CLI
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Run from the `cli/` directory:
|
|
4
4
|
|
|
5
5
|
```bash
|
|
6
|
-
bun
|
|
6
|
+
bun run index.ts --help
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
## Install (pre-built binary)
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
|
-
|
|
12
|
+
# macOS (Apple Silicon)
|
|
13
|
+
curl -O https://sites.wisp.place/nekomimi.pet/wisp-cli-binaries/wisp-cli-aarch64-darwin
|
|
14
|
+
chmod +x wisp-cli-aarch64-darwin
|
|
15
|
+
|
|
16
|
+
# macOS (Intel)
|
|
17
|
+
curl -O https://sites.wisp.place/nekomimi.pet/wisp-cli-binaries/wisp-cli-x86_64-darwin
|
|
18
|
+
chmod +x wisp-cli-x86_64-darwin
|
|
19
|
+
|
|
20
|
+
# macOS (Universal)
|
|
21
|
+
curl -O https://sites.wisp.place/nekomimi.pet/wisp-cli-binaries/wisp-cli-darwin-universal
|
|
22
|
+
chmod +x wisp-cli-darwin-universal
|
|
23
|
+
|
|
24
|
+
# Linux (x86_64)
|
|
25
|
+
curl -O https://sites.wisp.place/nekomimi.pet/wisp-cli-binaries/wisp-cli-x86_64-linux
|
|
26
|
+
chmod +x wisp-cli-x86_64-linux
|
|
27
|
+
|
|
28
|
+
# Linux (ARM64)
|
|
29
|
+
curl -O https://sites.wisp.place/nekomimi.pet/wisp-cli-binaries/wisp-cli-aarch64-linux
|
|
30
|
+
chmod +x wisp-cli-aarch64-linux
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Deploy a site
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
bun run index.ts deploy alice.bsky.social --path . --site my-blog
|
|
37
|
+
bun run index.ts alice.bsky.social --path . --site my-blog
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Pull a site from PDS
|
|
41
|
+
|
|
42
|
+
Download a site from the PDS to your local machine (uses OAuth authentication):
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
# Pull to a specific directory
|
|
46
|
+
bun run index.ts pull alice.bsky.social --site my-blog --output ./my-blog
|
|
47
|
+
|
|
48
|
+
# Pull to current directory
|
|
49
|
+
bun run index.ts pull alice.bsky.social --site my-blog
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Serve a site locally
|
|
53
|
+
|
|
54
|
+
Run a local server that monitors the firehose for real-time updates (uses OAuth authentication):
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
# Serve on http://localhost:8080 (default)
|
|
58
|
+
bun run index.ts serve alice.bsky.social --site my-blog
|
|
59
|
+
|
|
60
|
+
# Serve on a custom port
|
|
61
|
+
bun run index.ts serve alice.bsky.social --site my-blog --port 3000
|
|
62
|
+
|
|
63
|
+
# Enable SPA mode (serve index.html for all routes)
|
|
64
|
+
bun run index.ts serve alice.bsky.social --site my-blog --spa
|
|
65
|
+
|
|
66
|
+
# Enable directory listing for paths without index files
|
|
67
|
+
bun run index.ts serve alice.bsky.social --site my-blog --directory
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## List domains / sites
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
bun run index.ts list domains alice.bsky.social
|
|
74
|
+
bun run index.ts list sites alice.bsky.social
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## Domain CRUD
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
bun run index.ts domain claim alice.bsky.social --domain example.com
|
|
81
|
+
bun run index.ts domain claim-subdomain alice.bsky.social --subdomain alice
|
|
82
|
+
bun run index.ts domain status alice.bsky.social --domain example.com
|
|
83
|
+
bun run index.ts domain add-site alice.bsky.social --domain example.com --site mysite
|
|
84
|
+
bun run index.ts domain delete alice.bsky.social --domain example.com
|
|
85
|
+
bun run index.ts site delete alice.bsky.social --site mysite
|
|
13
86
|
```
|
|
14
87
|
|
|
15
|
-
|
|
88
|
+
## Options
|
|
89
|
+
|
|
90
|
+
Use an alternate proxy service DID:
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
bun run index.ts list domains alice.bsky.social --service did:web:regents-macbook-air.west-major.ts.net
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
## OAuth note
|
|
97
|
+
|
|
98
|
+
- CLI requests `rpc:<nsid>?aud=*` scopes for Wisp XRPC methods.
|
|
99
|
+
- `--service did:...` controls proxy target (`atproto-proxy`), not scope audience (scoping audience couldnt work for me idk why).
|