Ask your fleet questions. Get real answers.
Xyte CLI connects the AI assistant you already use to your Xyte fleet. Set it up once, then copy a prompt below to get a daily fleet report, a firmware report, or a morning check that recovers offline rooms before anyone walks in.
Three steps. No terminal skills needed.
You'll need a Xyte account and an AI assistant that can run commands on your computer, such as Claude, Codex, or GitHub Copilot in Agent mode.
Create an API key
In Xyte, go to Settings → API Keys and create a key. Save it in a text file on your computer, outside any project folder.
Paste the setup prompt
Copy the prompt below into your assistant. It installs Xyte CLI with its skills and checks that everything works.
Ask for what you need
When setup is done, pick a prompt from the library below, or just ask a question about your fleet in your own words.
Setup prompt
Paste this into your assistant once. It takes a few minutes.
You'll get
- Xyte CLI installed and working from any folder
- Your API key connected securely
- A quick count of your devices and spaces
Tip
- Replace the [highlighted text] before sending
- Restart your assistant afterward if it asks you to, so it picks up the new skills
Copy, paste, get the answer.
Each prompt works as written. Fill in the highlighted parts, or leave them out to cover your whole fleet. Change anything you like: your assistant understands plain language.
Daily fleet report
A one-page status of your whole fleet for a morning check-in, a team handoff, or a customer update.
You'll get
- A PDF you can forward as-is
- A JSON file with the source data
- A short summary in chat
Make it yours
- "…and email it to me at [address]"
- "…and make this run every weekday at 8 AM" (see Automations)
Firmware vulnerability report
See which firmware versions are running across your fleet, and where unknown or out-of-date firmware puts rooms at risk.
You'll get
- A highest-risk rooms table
- Firmware version spread by model
- A PDF plus the JSON inventory
Good to know
- Xyte shows what firmware is running. To match versions to specific published vulnerabilities, check each manufacturer's security notices.
Executive health summary
A short, non-technical summary for leadership or a quarterly business review.
You'll get
- A one-page PDF in plain language
Make it yours
- "…and match our brand colors"
What should we look at first?
When there are lots of alerts, get a short, ranked list of what matters.
What changed since yesterday?
A quick picture of what's new, what's resolved, and what got worse.
Check on one site or room
Answer "is that room OK?" before a big meeting or a site visit.
Fix offline rooms before the first meeting.
Schedule a prompt to run on its own every morning. Test it first with a dry run, approve what it will do, then put it on a schedule.
Do a dry run
Paste the prompt and ask your assistant to show you what it would do, without sending any commands.
Approve the plan
Check the rooms, devices, and commands it lists. Ask for changes until you're happy with them.
Schedule it
Ask your assistant to run it on a schedule, or add it under Scheduled tasks in Claude or Codex.
Morning room recovery
Checks every room, tries a safe reboot on devices that are offline or in an error state, confirms whether they recovered, and emails you a report.
You'll get
- A room-by-room PDF with recovered / not recovered status
- A short list of devices that need a person
- An email every morning
Make it yours
- "…only on weekdays"
- "…skip rooms that are booked in the next 30 minutes"
- "…if a device fails 3 days in a row, open a ticket"
Scheduled daily fleet report
The daily fleet report, delivered to your inbox every morning. Nothing on your devices changes.
Get better answers
A few habits that make every prompt work better.
Start with "Use xyte-cli"
This tells your assistant to get live data from your fleet instead of answering from general knowledge.
Say who it's for
"For my team" gets detail. "For the customer" or "for leadership" gets a cleaner, shorter report.
Ask for a file
Add "make it a PDF" or "save it as a spreadsheet" to get something you can forward right away.
Look before you change
Ask questions and run reports first. When you want changes, ask for a dry run so you can approve the plan.
Ask for real data only
"Don't guess or fill in numbers" keeps reports accurate. AI can still make mistakes, so check anything important.
Keep your skills current
Every so often, ask: "Update your Xyte CLI skills from github.com/xyte-io/xyte-cli."
See Xyte CLI in action
A quick walkthrough of setup and your first fleet report.
Common questions
Most problems can be fixed by telling your assistant what happened.
My assistant says "xyte-cli: command not found"
Xyte CLI is installed but your computer can't find it from this folder. Ask your assistant: "Make xyte-cli work from any folder, then check it in a new terminal."
It says I need Node.js 22 or later
Xyte CLI runs on Node.js. Ask your assistant: "Install or update Node.js to version 22 or later, then continue the Xyte CLI setup." On a work computer, you may need IT to approve the install.
The report is missing numbers or looks wrong
Ask: "Which of these numbers came directly from xyte-cli, and which didn't?" Then ask it to re-run using only xyte-cli data. If some devices don't report a value (like power or firmware), ask for them in a separate list.
Which AI assistants work?
Any assistant that can run commands on your computer: Claude, Codex, and GitHub Copilot in Agent mode. Chat-only assistants can't run Xyte CLI.
Is it safe to let an AI assistant send commands to devices?
Your assistant can only do what your API key allows, and every action is logged in Xyte's audit trail. Reports and questions are read-only. For anything that changes a device, use a dry run first and approve the plan. Keep scheduled automations to safe recovery commands like reboot or power on.
I prefer the terminal. What are the commands?
Requires Node.js 22+.
# check your environment and follow its recommendation npx -y @xyteai/cli@latest doctor environment --format json # connect your API key and confirm xyte-cli setup run xyte-cli setup status --field tenantId # set up agent skills in this project xyte-cli init --scope project --agents all --no-setup
For CI and headless jobs, pin a version instead of @latest. See the CI and agents guide and the commands reference.
Guides and reference
Step-by-step guides for specific jobs, plus the full technical reference.
Your first fleet report is five minutes away.
Create an API key, paste the setup prompt, and ask your first question.