@kya-os/cli 2.1.2 → 2.2.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.
Files changed (2) hide show
  1. package/README.md +16 -4
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -30,18 +30,29 @@ The published package resolves a prebuilt native binary for your platform (macOS
30
30
  ## Quick start
31
31
 
32
32
  ```bash
33
- # Initialize your agent identity, profiles, and integrations
34
- npx -p @kya-os/cli kya-os init
33
+ # Sign in, link this repository to a Checkpoint project, and add Detect
34
+ npx -p @kya-os/cli kya-os setup
35
35
 
36
36
  # Check system health and compatibility
37
37
  npx -p @kya-os/cli kya-os doctor
38
+ ```
39
+
40
+ ## Preview commands
41
+
42
+ `kya-os --help` lists the stable commands: `setup`, `login`, `logout`, `whoami`, `projects`, `detect`, `mcp`, `govern`, `checkpoint`, `doctor` and `preview`. Everything else, including agent identity (`init`, `register`, `dco`, `agent`), the workbench (`task`, `track`, `runner`, `mailbox`, `workload`), the TUI and the verifiers, is a preview: it can change or break between releases. Previews stay out of `--help`, and typed at a terminal they refuse to run until previews are on:
38
43
 
39
- # Show your agent's status
40
- npx -p @kya-os/cli kya-os status
44
+ ```bash
45
+ kya-os preview # which commands are previews, and whether they're on
46
+ kya-os preview enable # turn them on (saved in ~/.kya-os/config.json)
47
+ KYA_OS_PREVIEW=1 kya-os … # or for one shell; KYA_OS_PREVIEW=0 turns them off for one
41
48
  ```
42
49
 
50
+ Started by another program with no terminal (a service unit, `@kya-os/mcp-i`, a worker image, an MCP client), a preview runs exactly as it always has.
51
+
43
52
  ## Commands
44
53
 
54
+ Apart from `checkpoint` and `doctor`, the commands below are previews.
55
+
45
56
  ### `init`
46
57
 
47
58
  Initialize this project's agent identity, profiles, and integrations, through an interactive setup flow.
@@ -228,6 +239,7 @@ kya-os start
228
239
  - `KYA_API_KEY` - API key for authentication
229
240
  - `KYA_ENV` - Environment (development/staging/production)
230
241
  - `NO_COLOR` - Disable all colors (respects the NO_COLOR standard)
242
+ - `KYA_OS_PREVIEW` - `1` turns preview commands on for this shell, `0` turns them off, whatever `kya-os preview` saved
231
243
  - `MCPI_SIDECAR_SOCKET_PATH` / `MCPI_SIDECAR_PID_PATH` / `MCPI_SIDECAR_IDLE_MS` - Override where the sidecar daemon listens and how long it stays alive; mainly useful for tests
232
244
 
233
245
  ## Configuration
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kya-os/cli",
3
- "version": "2.1.2",
3
+ "version": "2.2.0",
4
4
  "description": "CLI for KYA-OS setup and management",
5
5
  "keywords": [
6
6
  "cli",
@@ -64,9 +64,9 @@
64
64
  "node": ">=20.19.0"
65
65
  },
66
66
  "optionalDependencies": {
67
- "@kya-os/cli-darwin-arm64": "2.1.2",
68
- "@kya-os/cli-darwin-x64": "2.1.2",
69
- "@kya-os/cli-linux-arm64-gnu": "2.1.2",
70
- "@kya-os/cli-linux-x64-gnu": "2.1.2"
67
+ "@kya-os/cli-darwin-arm64": "2.2.0",
68
+ "@kya-os/cli-darwin-x64": "2.2.0",
69
+ "@kya-os/cli-linux-arm64-gnu": "2.2.0",
70
+ "@kya-os/cli-linux-x64-gnu": "2.2.0"
71
71
  }
72
72
  }