XYTE AI CLI Operations for teams and AI agents Install from npm

AI-powered orchestration in the terminal

Operate Xyte with command-line clarity.

@xyteai/cli exposes the real commands from install to tenant setup, fleet inspection, console workflows, and exportable PDF or JSON handoff artifacts.

Start installation View on GitHub
Node 22+ Read-first operator flows CLI, JSON, and PDF outputs

See it in action

Install

Get running in three steps.

Install the package globally, initialize your workspace, connect a tenant key, and verify readiness. Then move into fleet inspection, incident watch, or report generation.

Step 1 · Core install

npm install -g @xyteai/cli@latest
xyte-cli init --no-setup
xyte-cli --version
Open npm package

Step 2 · Connect and verify

  1. 01 Connect the tenant key once Run interactive setup once, or use the documented stdin flow for automation. xyte-cli setup run
  2. 02 Read readiness back out Confirm the tenant is connected and capture the tenant ID for subsequent commands. xyte-cli setup status --field tenantId
  3. 03 Start with read-oriented workflows Watch incidents, inspect devices, open console screens, or generate PDF reports.

Step 3 · Next commands

  • Watch incidents once xyte-cli ops watch incidents --tenant <tenant-id> --profile incidents-active --once
  • Export a deep-dive snapshot xyte-cli ops inspect deep-dive --tenant <tenant-id> --window 24 --output json --out ./artifacts/deep-dive.json
  • Generate a report artifact xyte-cli ops report generate --tenant <tenant-id> --input ./artifacts/deep-dive.json --out ./reports/fleet-report.pdf

Agents

First-class support for AI coding agents.

Drop a structured prompt into Codex, Claude, or Copilot. The CLI provides deterministic, machine-readable outputs that agents can parse and act on.

Copyable prompt

Use @xyteai/cli in this workspace. Keep it concise and safe.

Rules:
- Never print secrets.
- Do not invent IDs or outputs.

Run:
npm install -g @xyteai/cli@latest
xyte-cli init --no-setup

Then connect the tenant:
xyte-cli setup run
xyte-cli setup status --field tenantId

Read tenantId from setup status and continue:
xyte-cli ops watch incidents --tenant <tenant-id> --profile incidents-active --once --output json --strict-json
xyte-cli ops inspect deep-dive --tenant <tenant-id> --window 24 --output json --out ./artifacts/deep-dive.json
xyte-cli ops report generate --tenant <tenant-id> --input ./artifacts/deep-dive.json --out ./reports/fleet-report.pdf
Open agent guidance

Operator defaults

  • Read-first by default Human operators see readable terminal output. Agents add --output json --strict-json when they need machine-parseable results.
  • Strict JSON is opt-in Machine output is enabled per command, not globally. The boundary between human and agent modes stays clear.
  • Copy-paste ready One prompt covers install, setup, inspection, and reporting. Paste it into your agent and go.

Workflow

From install to fleet report in four steps.

Install the CLI, connect tenant context, inspect fleet state, and generate artifacts. Each step feeds the next.

01

Install and init

Install from npm, then scaffold agent configs for Codex, Claude, and Copilot.

xyte-cli init --no-setup
02

Connect tenant

Provide your API key once. Verify with setup status before running operational commands.

xyte-cli setup run
03

Inspect fleet state

Watch incidents, inspect devices, and browse console screens before making changes.

xyte-cli ops inspect fleet --output json
04

Export artifacts

Generate deep-dive JSON snapshots and PDF reports you can share or feed into other tools.

xyte-cli ops report generate ...

Docs and contracts

Reference and contracts.

Guides for first-run onboarding, full command reference, agent integration patterns, flow authoring, and machine-readable JSON schemas.

Getting started

First-run prerequisites, onboarding order, and the recommended setup sequence.

Open guide Commands reference

Exact command behavior, operator-facing examples, and the practical CLI surface area.

Open commands Agent guidance

Patterns for using xyte-cli safely from Codex, Claude, or similar agent workflows.

Open agents Built-in flows

Deterministic operational flow packs for incident response and repeated operator scenarios.

Open flows Custom workflows

Create, edit, share, and import reusable workflow definitions for your environment.

Open authoring Schema contracts

Machine-readable JSON contracts in docs/schemas for validation and automation.

Open schemas

Ready to run

Start operating.

Install the CLI, connect your tenant, and run your first fleet inspection in under five minutes.

Install now View repository