kiln-cli 0.1.0-test.20260809.220552
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/COMMERCIAL_LICENSE.md +172 -0
- package/LICENSE +687 -0
- package/README.md +72 -0
- package/kiln.mjs +166 -0
- package/package.json +30 -0
package/README.md
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# Kiln CLI
|
|
2
|
+
|
|
3
|
+
Agent-first command-line access to Hearth. Output is JSON by default, log
|
|
4
|
+
streams are NDJSON, and failures use a stable `error.code`, `message`, and
|
|
5
|
+
`retryable` shape.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
Run without a global install:
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
npx kiln-cli --version
|
|
13
|
+
npx kiln-cli login
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Or install it globally. The npm package is named `kiln-cli`; both installation
|
|
17
|
+
methods expose the `kiln` command.
|
|
18
|
+
|
|
19
|
+
```sh
|
|
20
|
+
npm install --global kiln-cli
|
|
21
|
+
kiln login
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Build locally
|
|
25
|
+
|
|
26
|
+
```sh
|
|
27
|
+
pnpm --filter kiln-cli build
|
|
28
|
+
./apps/cli/dist/kiln --version
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Bun compiles the app into `dist/kiln`; Bun does not need to be installed on
|
|
32
|
+
the machine running that executable. Local macOS builds are ad-hoc signed with
|
|
33
|
+
the JavaScript runtime entitlements required by Bun.
|
|
34
|
+
|
|
35
|
+
## Authenticate
|
|
36
|
+
|
|
37
|
+
```sh
|
|
38
|
+
kiln login
|
|
39
|
+
kiln login https://hearth.example.com --name build-agent --no-open
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
The first form targets `https://kiln.site`. The command prints an
|
|
43
|
+
`authorization_required` record and waits while the user approves the link in
|
|
44
|
+
their browser. Self-hosted Hearth installations are selected with the
|
|
45
|
+
positional URL or `--url`. Named profiles are available through `--profile`.
|
|
46
|
+
|
|
47
|
+
For ephemeral agents, `KILN_URL` and `KILN_TOKEN` bypass the saved profile.
|
|
48
|
+
Saved profiles live under the platform config directory with owner-only file
|
|
49
|
+
permissions.
|
|
50
|
+
|
|
51
|
+
## Discover and operate
|
|
52
|
+
|
|
53
|
+
```sh
|
|
54
|
+
kiln capabilities
|
|
55
|
+
kiln servers list
|
|
56
|
+
kiln server power <relay-id>:<instance-id> restart
|
|
57
|
+
kiln server logs <relay-id>:<instance-id> --follow
|
|
58
|
+
kiln server console <relay-id>:<instance-id> "say deploy complete"
|
|
59
|
+
kiln files list <relay-id>:<instance-id> .
|
|
60
|
+
kiln files read <relay-id>:<instance-id> server.properties --raw
|
|
61
|
+
kiln files write <relay-id>:<instance-id> server.properties ./server.properties
|
|
62
|
+
kiln files download <relay-id>:<instance-id> logs/latest.log ./latest.log
|
|
63
|
+
kiln files upload <relay-id>:<instance-id> ./plugins/example.jar plugins/example.jar
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Uploads and downloads use the Relay SFTP endpoint and verify its advertised
|
|
67
|
+
SSH host-key fingerprint. Other file operations use the versioned CLI API.
|
|
68
|
+
Read-only credentials can discover servers, follow logs, and read files, but
|
|
69
|
+
cannot power servers, send console commands, modify files, or upload.
|
|
70
|
+
|
|
71
|
+
Use `--output human` for interactive output. Run `kiln help` for the complete
|
|
72
|
+
machine-readable command manifest.
|