OpsSquad
Getting Started

First Deployment

Install the CLI and deploy your first OpsSquad.ai node

This guide walks you through installing the OpsSquad CLI, deploying your first node, and linking it to an agent.

Prerequisites

Before starting, ensure you have:

  • An OpsSquad.ai account with a squad created (Account Setup)
  • Your Node ID and Token from the dashboard
  • A server running Linux, macOS, or Windows
  • Network access to socket.opssquad.ai:9000

Install the CLI

The fastest way to install the OpsSquad CLI is using the automated installation script:

curl -fsSL https://install.opssquad.ai/install.sh | bash

The script automatically:

  • Detects your operating system and architecture
  • Downloads the latest CLI version
  • Installs to the appropriate location
  • Adds opssquad to your PATH

Note: For manual installation options or building from source, see the CLI Installation Guide.

Verify Installation

Confirm the CLI is installed correctly:

opssquad --version

You should see output like:

opssquad version 1.0.0 (abc1234)

Deploy Your Node

With the CLI installed, deploy a node using your credentials from the dashboard:

opssquad node install \
  --node-id="your-node-id" \
  --token="your-token"

Replace your-node-id and your-token with the credentials you saved when creating your node in the dashboard.

What Happens During Installation

The installation process:

  1. Registers the node with the OpsSquad.ai platform
  2. Downloads the connectivity layer binary
  3. Creates configuration files in the appropriate locations
  4. Starts the node service (systemd on Linux, or background process)

Verify Your Node

Check that your node is running and connected:

opssquad node status

You should see output indicating the node is Active and Connected:

Node Status:  Active
Connection:   Connected
Version:      1.0.0
Uptime:       2m 34s

View Node Logs

Monitor your node's activity in real-time:

opssquad node logs --follow

This shows:

  • Connection events
  • Task assignments
  • Command executions
  • Any errors or warnings

Press Ctrl+C to stop following logs.

Now that your node is deployed and connected, you need to create an agent and link it to your node:

1. Create an Agent in the Dashboard

  1. Navigate to the Agents page in the dashboard
  2. Click "Create Agent"
  3. Select your Squad from the dropdown
  4. Fill in the agent's name, description, and system prompt
  5. Click "Create Agent"
  1. On the agent detail page, locate the "Link to Node" section
  2. Select your deployed node from the dropdown
  3. Click "Link Node"

The agent is now linked to your node and ready to receive commands.

Connect via Chat

Now that your agent is linked to a node, you can interact with it:

  1. Open chat.opssquad.ai in your browser
  2. Log in with your OpsSquad.ai account
  3. Select your squad from the dropdown
  4. Select your agent
  5. Start chatting! Try asking:
    • "What's the current CPU usage?"
    • "Show me the last 10 lines of /var/log/syslog"
    • "List running Docker containers"

Troubleshooting First Deployment

Node won't start

Run the validation command to identify issues:

opssquad node validate

This checks for:

  • Configuration file validity
  • Permission issues
  • Network connectivity
  • Missing dependencies

Connectivity problems

Ensure your server can reach the OpsSquad.ai platform:

curl -I socket.opssquad.ai:9000

If this fails, check your firewall rules to allow outbound connections on port 9000.

Permission errors

If you installed as root, use sudo for management commands:

sudo opssquad node status

If you installed as a regular user, do not use sudo to avoid permission conflicts.

Next Steps

Congratulations! You've deployed your first OpsSquad.ai node and linked it to an agent. Here's what to explore next:

  • CLI Commands - Learn all available CLI commands for node management.
  • Chat Interface - Master the AI chat interface for interacting with agents.
  • Core Concepts - Understand agents, nodes, squads, and the OpsSquad.ai architecture.

On this page