@xyteai/cli 0.1.0

package/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,245 @@
+# xyte-cli
+
+Xyte CLI with SKILLS, built for coding agents and operators.
+
+`xyte-cli` provides deterministic access to Xyte APIs, a full TUI (without a Network tab), guarded write flows, headless NDJSON snapshots, and an MCP server.
+
+### xyte-cli vs xyte MCP
+
+- **CLI**: best fit for coding agents that need low-token, command-driven workflows.
+- **MCP**: available for tool-based integrations and external orchestration via `xyte-cli mcp serve`.
+
+### Key Features
+
+- One-command skill install flow: `xyte-cli install --skills`
+- Guided setup embedded into install flow (unless `--no-setup`)
+- Provider/slot key lifecycle (`add`, `use`, `update`, `rename`, `test`, `remove`)
+- Guarded endpoint writes (`--allow-write`) and deletes (`--confirm <endpoint-key>`)
+- Full TUI screens:
+  - `setup`, `config`, `dashboard`, `spaces`, `devices`, `incidents`, `tickets`
+- Provider-first Config screen with hotkeys:
+  - `a`, `e`, `u`, `t`, `x`, `n`, `c`, `r`
+- Headless JSON frames with stable contracts
+- Inspect/report pipelines with schema-versioned output
+
+## Requirements
+
+- Node.js 18+
+- A valid XYTE API key
+- Supported keychain backend:
+  - macOS Keychain
+  - Linux `secret-tool`
+  - test/runtime override: `XYTE_CLI_KEYCHAIN_BACKEND=memory`
+
+## Getting Started
+
+## Installation
+
+```bash
+npm install -g @xyte/cli@latest
+xyte-cli --help
+```
+
+### Install skills (recommended)
+
+```bash
+xyte-cli install --skills
+```
+
+By default, this command prompts for:
+- install scope: `project`, `user`, or `both`
+- agents: `all` or a subset of `claude,copilot,codex`
+
+Then it installs the same skill bundle to the selected destinations and runs guided setup in the same flow.
+
+When no prompt is available (CI/non-interactive), default is:
+- scope: `project`
+- agents: `all` (`claude`, `copilot`, `codex`)
+
+Path mapping:
+- Project scope:
+  - Claude: `.claude/skills/xyte-cli`
+  - Copilot: `.github/skills/xyte-cli`
+  - Codex: `.agents/skills/xyte-cli`
+- User scope:
+  - Claude: `~/.claude/skills/xyte-cli`
+  - Copilot: `~/.copilot/skills/xyte-cli`
+  - Codex: `~/.agents/skills/xyte-cli`
+
+Options:
+
+```bash
+xyte-cli install --skills --no-setup
+xyte-cli install --skills --target /path/to/workspace
+xyte-cli install --skills --scope project --agents claude,codex
+xyte-cli install --skills --scope both --agents all --force
+xyte-cli install --skills --force
+```
+
+### Non-interactive setup
+
+```bash
+XYTE_CLI_KEY="<your-key>" \
+xyte-cli setup run --non-interactive --tenant acme
+```
+
+### Skills-less operation
+
+Point your agent to `xyte-cli --help` and ask it to use CLI commands directly.
+
+Example prompt:
+
+```text
+Use xyte-cli to inspect tenant acme and generate a PDF report.
+Check xyte-cli --help first and keep outputs in JSON when possible.
+```
+
+## Visual Demo
+
+![XYTE TUI dashboard](docs/media/tui-dashboard-synthetic.png)
+
+![XYTE headless frame](docs/media/headless-frame-synthetic.png)
+
+## Commands
+
+### Core
+
+```bash
+xyte-cli install --skills [--target <path>] [--scope <project|user|both>] [--agents <all|claude|copilot|codex[,..]>] [--force] [--no-setup]
+xyte-cli doctor install --format json
+xyte-cli setup status --tenant <tenant-id> --format json
+xyte-cli setup run [--non-interactive] [--tenant <tenant-id>] [--key <value>]
+xyte-cli config doctor --tenant <tenant-id> --format json
+```
+
+### Tenant + Auth Slots
+
+```bash
+xyte-cli tenant add <tenant-id> --name "Acme"
+xyte-cli tenant use <tenant-id>
+xyte-cli tenant list
+
+xyte-cli auth key add --tenant <tenant-id> --provider xyte-org --name primary --key "<value>" --set-active
+xyte-cli auth key list --tenant <tenant-id> --format json
+xyte-cli auth key use --tenant <tenant-id> --provider xyte-org --slot primary
+xyte-cli auth key update --tenant <tenant-id> --provider xyte-org --slot primary --key "<value>"
+xyte-cli auth key rename --tenant <tenant-id> --provider xyte-org --slot primary --name prod-primary
+xyte-cli auth key test --tenant <tenant-id> --provider xyte-org --slot prod-primary
+xyte-cli auth key remove --tenant <tenant-id> --provider xyte-org --slot prod-primary --confirm
+```
+
+### Endpoint Operations
+
+```bash
+xyte-cli list-endpoints
+xyte-cli describe-endpoint organization.devices.getDevices
+xyte-cli call organization.devices.getDevices --tenant <tenant-id>
+xyte-cli call organization.devices.getDevices --tenant <tenant-id> --output-mode envelope
+```
+
+### Guarded Writes
+
+```bash
+xyte-cli call organization.commands.sendCommand \
+  --tenant <tenant-id> \
+  --allow-write \
+  --path-json '{"device_id":"DEVICE_ID"}' \
+  --body-json '{"name":"reboot"}'
+
+xyte-cli call organization.commands.cancelCommand \
+  --tenant <tenant-id> \
+  --allow-write \
+  --confirm organization.commands.cancelCommand \
+  --path-json '{"device_id":"DEVICE_ID","command_id":"COMMAND_ID"}'
+```
+
+### Insights + Reports
+
+```bash
+xyte-cli inspect fleet --tenant <tenant-id> --format json
+xyte-cli inspect deep-dive --tenant <tenant-id> --window 24 --format json > /tmp/deep-dive.json
+xyte-cli report generate --tenant <tenant-id> --input /tmp/deep-dive.json --out /tmp/xyte-report.pdf
+```
+
+### TUI + Headless
+
+```bash
+xyte-cli tui
+xyte-cli tui --headless --screen dashboard --format json --once --tenant <tenant-id>
+xyte-cli tui --headless --screen spaces --format json --follow --interval-ms 2000 --tenant <tenant-id>
+```
+
+### MCP
+
+```bash
+xyte-cli mcp serve
+```
+
+## Headless Contract IDs
+
+- `xyte.headless.frame.v1`
+- `xyte.call.envelope.v1`
+- `xyte.inspect.fleet.v1`
+- `xyte.inspect.deep-dive.v1`
+- `xyte.report.v1`
+
+Schemas:
+
+- `docs/schemas/headless-frame.v1.schema.json`
+- `docs/schemas/call-envelope.v1.schema.json`
+- `docs/schemas/inspect-fleet.v1.schema.json`
+- `docs/schemas/inspect-deep-dive.v1.schema.json`
+- `docs/schemas/report.v1.schema.json`
+
+## Agent Quick Start
+
+### Claude
+
+```bash
+xyte-cli install --skills
+claude
+```
+
+### Codex
+
+```bash
+xyte-cli install --skills
+# in Codex prompts, ask to run xyte-cli commands directly
+```
+
+### GitHub Copilot
+
+```bash
+xyte-cli install --skills
+# in Copilot prompts, ask to run xyte-cli commands directly
+```
+
+## Development
+
+```bash
+npm ci
+npm run typecheck
+npm test
+npm run build
+npm pack
+```
+
+Local package smoke:
+
+```bash
+npm i -g ./xyte-cli-*.tgz
+xyte-cli install --skills --no-setup
+```
+
+## Release
+
+Manual npm release steps are documented in:
+
+- `docs/release.md`
+
+## Skill Package Layout
+
+- `skills/xyte-cli/SKILL.md`
+- `skills/xyte-cli/references/`
+- `skills/xyte-cli/scripts/`
+- `skills/xyte-cli/agents/`

package/dist/bin/xyte-cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=xyte-cli.d.ts.map

package/dist/bin/xyte-cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"xyte-cli.d.ts","sourceRoot":"","sources":["../../src/bin/xyte-cli.ts"],"names":[],"mappings":""}

package/dist/bin/xyte-cli.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("../cli/index");
+const problem_1 = require("../contracts/problem");
+const error_format_1 = require("../utils/error-format");
+(0, index_1.runCli)().catch((error) => {
+    const errorFormat = (0, error_format_1.resolveCliErrorFormat)(process.argv.slice(2), process.env.XYTE_ERROR_FORMAT);
+    if (errorFormat === 'json') {
+        process.stderr.write(`${JSON.stringify((0, problem_1.toProblemDetails)(error), null, 2)}\n`);
+        process.exit(1);
+        return;
+    }
+    const message = error instanceof Error ? error.message : String(error);
+    process.stderr.write(`${message}\n`);
+    process.exit(1);
+});
+//# sourceMappingURL=xyte-cli.js.map

package/dist/bin/xyte-cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"xyte-cli.js","sourceRoot":"","sources":["../../src/bin/xyte-cli.ts"],"names":[],"mappings":";;;AAEA,wCAAsC;AACtC,kDAAwD;AACxD,wDAA8D;AAE9D,IAAA,cAAM,GAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACvB,MAAM,WAAW,GAAG,IAAA,oCAAqB,EAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAChG,IAAI,WAAW,KAAK,MAAM,EAAE,CAAC;QAC3B,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAA,0BAAgB,EAAC,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;QAC9E,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChB,OAAO;IACT,CAAC;IAED,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACvE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC;IACrC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/dist/cli/index.d.ts

@@ -0,0 +1,24 @@
+import { Command } from 'commander';
+import { type KeychainStore } from '../secure/keychain';
+import { type ProfileStore } from '../secure/profile-store';
+import { runTuiApp } from '../tui/app';
+type OutputStream = Pick<typeof process.stdout, 'write'>;
+type ErrorStream = Pick<typeof process.stderr, 'write'>;
+type PromptValueFn = (args: {
+    question: string;
+    initial?: string;
+    stdout: OutputStream;
+}) => Promise<string>;
+export interface CliRuntime {
+    profileStore?: ProfileStore;
+    keychain?: KeychainStore;
+    stdout?: OutputStream;
+    stderr?: ErrorStream;
+    runTui?: typeof runTuiApp;
+    promptValue?: PromptValueFn;
+    isTTY?: boolean;
+}
+export declare function createCli(runtime?: CliRuntime): Command;
+export declare function runCli(argv?: string[], runtime?: CliRuntime): Promise<void>;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/cli/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAOpC,OAAO,EAAuB,KAAK,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAE7E,OAAO,EAAoB,KAAK,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAW9E,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAavC,KAAK,YAAY,GAAG,IAAI,CAAC,OAAO,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACzD,KAAK,WAAW,GAAG,IAAI,CAAC,OAAO,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAExD,KAAK,aAAa,GAAG,CAAC,IAAI,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,YAAY,CAAA;CAAE,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAa7G,MAAM,WAAW,UAAU;IACzB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,MAAM,CAAC,EAAE,OAAO,SAAS,CAAC;IAC1B,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAqWD,wBAAgB,SAAS,CAAC,OAAO,GAAE,UAAe,GAAG,OAAO,CA0gC3D;AAED,wBAAsB,MAAM,CAAC,IAAI,WAAe,EAAE,OAAO,GAAE,UAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAGzF"}