Operate Xyte with command-line clarity.

Before you start: in Xyte, open Settings → API Keys and create a key. Save it in a plain text file outside your project folder (for example xyte-api-key.txt on your Desktop) — any text editor works. Your agent will ask for the file's path.

Paste this into Claude Code, Codex, or Copilot Agent mode:

Use @xyteai/cli in this workspace.Never print secrets. Do not invent IDs or outputs.
First run `xyte-cli doctor environment --format json`.If `xyte-cli` is missing, run `npx -y @xyteai/cli@latest doctor environment --format json`.Follow the report's recommendations.nextCommand and recommendations.commands.
If `xyte-cli setup status` shows no connected profile, ask me for the path to my API key file (never the key itself) and connect it with the report's setupKeyFile recipe.Do not ask me to paste API keys into chat.Do not store API keys inside the repo.After setup succeeds, offer to delete the key file, then run `xyte-cli init --scope project --agents all --force --no-setup`.
If this surface cannot run shell commands, stop and say I need a shell-capable terminal or agent.

1. In Xyte, open Settings → API Keys and create a key.
2. In your CI tool (GitHub Actions, GitLab CI, Jenkins), add a secret named XYTE_CLI_KEY and paste the key as its value.
3. Make sure the job receives the secret as an environment variable — in GitHub Actions add env: XYTE_CLI_KEY: ${{ secrets.XYTE_CLI_KEY }} to the step; GitLab CI passes variables automatically.
4. Add these commands to your pipeline. The setup command stores the key under the default profile.

printf "%s" "$XYTE_CLI_KEY" | npx -y @xyteai/cli@latest setup run --non-interactive --key-stdin --format jsonnpx -y @xyteai/cli@latest setup status --field tenantId

This CI path is read-oriented by default. Use plan-mode flows for change workflows and reserve apply steps for a separate approved job. For reproducible builds, pin a known version (@xyteai/cli@<version>) instead of @latest.

# Manual terminal: global installnpm install -g @xyteai/cli@latestxyte-cli init --no-setupxyte-cli --version

Connect and verify

1. 01 Connect the API key once Create an API key in your Xyte tenant under Settings → API Keys and save it in a file outside your project folder. Run interactive setup once, or use the documented stdin flow for automation. The key prompt hides input and confirms with a Received N characters. line. Persisted credentials default to macOS Keychain, Windows DPAPI, or Linux Secret Service. xyte-cli setup run
2. 02 Read readiness back out Confirm the profile is connected and use that profile label 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.