@impulselab/hepha 0.1.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 ADDED
@@ -0,0 +1,47 @@
1
+ # `hepha`
2
+
3
+ Command-line interface for creating and operating
4
+ [Hephaistos](https://hephaistos.impulselab.ai) sessions.
5
+
6
+ ## Install
7
+
8
+ ```bash
9
+ npm install --global @impulselab/hepha
10
+ ```
11
+
12
+ Node.js 20 or newer is required.
13
+
14
+ ## Quick start
15
+
16
+ ```bash
17
+ hepha login
18
+ hepha whoami
19
+ hepha run "Add rate limiting to the public API" \
20
+ --repo impulse-studio/hephaistos \
21
+ --follow
22
+ ```
23
+
24
+ Run `hepha help` to see all commands. The full API reference is available at
25
+ <https://hephaistos.impulselab.ai/api/v1/docs>.
26
+
27
+ ## Authentication
28
+
29
+ `hepha login` uses device authorization and stores the resulting session in
30
+ `~/.hepha/config.json`.
31
+
32
+ For scripts and agents, use an API key:
33
+
34
+ ```bash
35
+ export HEPHA_API_KEY="..."
36
+ hepha sessions list --json
37
+ ```
38
+
39
+ `HEPHA_API_KEY` takes precedence over a stored login. `HEPHA_URL` can point the
40
+ CLI at another Hephaistos deployment.
41
+
42
+ ## Exit codes
43
+
44
+ - `0`: completed successfully
45
+ - `1`: failed, killed, or abstained
46
+ - `2`: invalid CLI usage
47
+ - `3`: waiting for a human question or approval