Skip to content
Osuite Osuite Docs

Set up the Osuite AI agents

The Osuite AI agents run as skills inside your AI IDE. This page is the one-time setup shared by every agent: create an API key, install the Osuite CLI, authenticate it, and install the agent skills with osuite init-ai. Do it once and every agent — Instrumentation, Investigation, Visualizer, and Write PromQL — becomes available as a slash command.

Prerequisites

Section titled “Prerequisites”
  • An Osuite Cloud account
  • Node.js and npm installed
  • An AI IDE that supports agent skills (see Supported AI IDEs)

Step 1: Create your API key

Section titled “Step 1: Create your API key”

An API key lets the CLI and the agents interact with Osuite. Create one in the Osuite UI under Settings → API Keys, then copy it — you will need it in Step 3.

Step 2: Install the Osuite CLI

Section titled “Step 2: Install the Osuite CLI”
Terminal window
npm install @osuite/cli -g

Step 3: Authenticate the CLI

Section titled “Step 3: Authenticate the CLI”

The agents use the osuite CLI to query your telemetry and apply changes. Point it at your account by adding the following to your shell profile:

Terminal window
export OSUITE_API_ENDPOINT=https://api.<region>.osuite.io
export OSUITE_API_KEY=<your-api-key>

Run osuite whoami to confirm you are authenticated.

Step 4: Install the agent skills

Section titled “Step 4: Install the agent skills”
Terminal window
osuite init-ai

osuite init-ai installs the Osuite agent skills globally so your AI IDE can invoke them. It installs all four agents: Instrumentation (/osuite-instrument), Investigation (/osuite-investigate), Visualizer (/osuite-edit-dashboard), and Write PromQL (/osuite-write-promql).

To pick up newer skill versions later, run osuite upgrade, which updates the CLI and refreshes the installed skills.

Supported AI IDEs

Section titled “Supported AI IDEs”

The agents install as standard agent skills, so any AI IDE that supports skills can invoke them, including:

  • Cursor
  • Antigravity
  • Claude Code

Once installed, trigger any agent from your IDE as a slash command — for example /osuite-investigate the checkout API is throwing 500s.

Next steps

Section titled “Next steps”