kylon-cli 0.3.1 → 0.3.3-next.535
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 +32 -7
- package/dist/kylon-bundle.mjs +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -6,13 +6,31 @@ Requires Node.js 22.15.0 or newer.
|
|
|
6
6
|
|
|
7
7
|
## Install
|
|
8
8
|
|
|
9
|
-
The
|
|
9
|
+
The recommended install is the hosted script (macOS/Linux):
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
curl -fsSL https://api.kylon.io/install.sh | sh
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
It installs the pinned CLI bundle under `~/.kylon` (no sudo; a machine
|
|
16
|
+
without Node.js gets a private, checksum-verified runtime under
|
|
17
|
+
`~/.kylon/runtime` that only Kylon uses), puts `kylon` on your PATH, records
|
|
18
|
+
the serving environment as the default `--server-url`, and chains straight
|
|
19
|
+
into `kylon login`. Rerunning it is safe. Non-production deployments serve
|
|
20
|
+
the same script from their own API origin (for example
|
|
21
|
+
`https://api.purework.ai/install.sh` installs `@next` and logs into dev).
|
|
22
|
+
`KYLON_INSTALL_NO_LOGIN=1` installs without starting the login;
|
|
23
|
+
`KYLON_INSTALL_NO_MODIFY_PATH=1` leaves shell profiles untouched.
|
|
24
|
+
|
|
25
|
+
The CLI is also published to npm as
|
|
10
26
|
[`kylon-cli`](https://www.npmjs.com/package/kylon-cli). The Web UI provides
|
|
11
27
|
two distinct copy-paste entry points:
|
|
12
28
|
|
|
13
29
|
- **Settings → Developer tools → Kylon CLI** shows
|
|
14
30
|
`npx --yes kylon-cli@<tag> auth login --workspace <id>` — authorizes this
|
|
15
|
-
installation for human workspace commands.
|
|
31
|
+
installation for human workspace commands. Once installed, `kylon login`
|
|
32
|
+
with no flags does the same and lets the browser approval page choose the
|
|
33
|
+
workspace. Its **Use with Your Agents**
|
|
16
34
|
prompt teaches Claude Code, Codex, Hermes, or OpenClaw to discover and use
|
|
17
35
|
`kylon workspace` commands without assuming a provider-specific interface.
|
|
18
36
|
- **An external agent's Profile** shows
|
|
@@ -37,8 +55,13 @@ never do, even though they serve the same workspace ids as dev. Run
|
|
|
37
55
|
local runtime registration; it revokes nothing or changes any workspace-side
|
|
38
56
|
agent configuration.
|
|
39
57
|
|
|
40
|
-
`auth login` browser-authenticates the human operator for
|
|
41
|
-
|
|
58
|
+
`kylon login` (alias `auth login`) browser-authenticates the human operator for
|
|
59
|
+
`kylon workspace` commands. `--workspace <id>` pins the workspace up front;
|
|
60
|
+
without it the browser approval page asks the user to choose one, defaulting to
|
|
61
|
+
the workspace they most recently worked in. The default API server resolves
|
|
62
|
+
from `--server-url`, then the server env vars, then the URL recorded by the
|
|
63
|
+
hosted install script in `~/.kylon/server-url`, then production.
|
|
64
|
+
`agent link` authenticates only the link operation with its embedded
|
|
42
65
|
credential; it never creates a human CLI session. Linking mints or reuses an
|
|
43
66
|
installation credential stored locally with mode `0600` and starts the local
|
|
44
67
|
agent runtime. In release builds on supported environments a user-level
|
|
@@ -151,9 +174,11 @@ command, or run:
|
|
|
151
174
|
npx --yes kylon-cli@latest auth login --workspace <WORKSPACE_ID>
|
|
152
175
|
```
|
|
153
176
|
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
177
|
+
(or, once `kylon` is installed, just `kylon login` — the browser page then asks
|
|
178
|
+
which workspace to authorize). The CLI opens Kylon in your browser. After you
|
|
179
|
+
sign in, confirm the installation and workspace shown on the authorization
|
|
180
|
+
page, and verify that its confirmation code matches the one printed in your
|
|
181
|
+
terminal. The browser approves a short-lived
|
|
157
182
|
request but never receives the credential. The CLI proves possession of its PKCE
|
|
158
183
|
verifier while polling Kylon over HTTPS, receives the credential directly from
|
|
159
184
|
the API, and saves it in the versioned credential collection at
|