@warmhub/cli 0.44.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.
- package/README.md +51 -0
- package/dist/wh.js +36808 -0
- package/package.json +36 -0
package/README.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# @warmhub/cli
|
|
2
|
+
|
|
3
|
+
The `wh` command-line interface for [WarmHub](https://warmhub.ai) — create repos, write data, query state, and bootstrap agent context from your terminal. See the [CLI quickstart](https://docs.warmhub.ai/get-started/quickstart-cli/) for a guided walkthrough.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
Requires Node 22+.
|
|
8
|
+
|
|
9
|
+
Install the promoted stable build:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install -g @warmhub/cli@latest
|
|
13
|
+
wh --version
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Shakeout builds are available on `next`:
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npm install -g @warmhub/cli@next
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Update an existing install:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
wh update
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Update Check Behavior
|
|
29
|
+
|
|
30
|
+
- Update prompts are TTY-only and disabled in CI/non-interactive runs.
|
|
31
|
+
- CLI checks the public npm registry in the background and caches results.
|
|
32
|
+
- Use `WARMHUB_CLI_UPDATE_REGISTRY` only when intentionally overriding the update registry.
|
|
33
|
+
- Opt out entirely with:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
export WARMHUB_CLI_NO_UPDATE_CHECK=1
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Usage
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
wh help # overview of all domains and verbs
|
|
43
|
+
wh prime # structured CLI reference for AI agents
|
|
44
|
+
wh prime --json # JSON version
|
|
45
|
+
|
|
46
|
+
wh <domain> <verb> [args] [flags]
|
|
47
|
+
wh thing list --repo org/repo
|
|
48
|
+
wh thing history Shape/name --json
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Run `wh <domain>` to list verbs, or `wh <domain> <verb> --help` for details.
|