SuperOps CLI

Command-line interface for the SuperOps.ai API. Part of the WYRE Technology CLI toolkit.

Features

• Clients Management: List, search, and retrieve client account information
• Tickets Management: Create, update, list tickets, add notes and time entries
• Assets Management: View and search endpoint/device inventory
• Technicians Management: List technicians and teams
• Flexible Output: JSON (default) or formatted tables
• Environment-based Auth: Secure credential management via environment variables

Installation

From GitHub Packages

npm install -g @wyre-technology/superops-cli

From Source

git clone https://github.com/wyre-technology/superops-cli.git
cd superops-cli
npm install
npm run build
npm link

Authentication

Set the following environment variables:

export SUPEROPS_API_TOKEN="your-api-token"
export SUPEROPS_SUBDOMAIN="your-subdomain"
export SUPEROPS_REGION="us"  # or "eu", defaults to "us"

You can also pass credentials via flags:

superops --api-token "token" --subdomain "subdomain" --region "us" clients list

Usage

Clients

# List all clients
superops clients list

# List with table output
superops clients list --format table

# Filter by status
superops clients list --status Active

# Get specific client
superops clients get <accountId>

# Search clients
superops clients search --query "company name"

Tickets

# List tickets
superops tickets list

# List with filters
superops tickets list --status Open --priority High --format table

# Get specific ticket
superops tickets get <ticketId>

# Create a new ticket
superops tickets create \
  --client-id "123" \
  --subject "Server down" \
  --description "Production server not responding" \
  --priority High

# Update ticket
superops tickets update <ticketId> --status "In Progress" --assignee-id "456"

# Add note to ticket
superops tickets add-note <ticketId> --content "Working on resolution" --public

# Add time entry
superops tickets add-time <ticketId> --duration 60 --description "Troubleshooting" --billable

Assets

# List all assets
superops assets list

# Filter by client
superops assets list --client-id "123" --format table

# Get specific asset
superops assets get <assetId>

# Search assets
superops assets search --query "SERVER-01"

# Get installed software
superops assets software <assetId> --format table

Technicians

# List technicians
superops technicians list

# Filter by status
superops technicians list --status Active --format table

# Get specific technician
superops technicians get <technicianId>

# List teams
superops technicians teams --format table

Output Formats

JSON (Default)

superops clients list

Returns structured JSON for programmatic use:

{
  "items": [...],
  "pagination": {...}
}

Table

superops clients list --format table

Returns human-readable formatted tables.

Common Options

• --format <format>: Output format (json or table, default: json)
• --max <number>: Maximum number of results
• --cursor <cursor>: Pagination cursor for next page
• --api-token <token>: Override API token
• --subdomain <subdomain>: Override subdomain
• --region <region>: Override region (us or eu)

Examples

Export all tickets to JSON file

superops tickets list --max 1000 > tickets.json

View active clients in table format

superops clients list --status Active --format table

Create ticket and add time entry

# Create ticket and capture ID
TICKET_ID=$(superops tickets create \
  --client-id "123" \
  --subject "New request" \
  --priority Medium | jq -r '.ticketId')

# Add time entry
superops tickets add-time "$TICKET_ID" --duration 30 --billable

Search for offline assets

superops assets list --status Offline --format table

Development

Building

npm run build

Type Checking

npm run typecheck

Linting

npm run lint

Testing

npm test

Related Projects

• @wyre-technology/node-superops - SuperOps.ai Node.js SDK
• @wyre-technology/superops-mcp - SuperOps.ai MCP Server

Support

For issues and feature requests, please use the GitHub issue tracker.

License

MIT License - see LICENSE file for details.

Contributing

See CONTRIBUTING.md for contribution guidelines.