CatOps
Updated Documentation updated with latest features.

Everything you need to know about CatOps. From quick setup to advanced configurations, we've got you covered with comprehensive guides and examples.

Quick Start API Reference

Documentation

Quick Start

Get CatOps up and running in less than 5 minutes with our simple installation process.

1. Install CatOps

curl -sfL https://catops.io/install.sh | bash

One curl command, zero setup hell. Ultra-lightweight server monitoring tool.

2. Quick Start (Local Mode)

catops start

Start monitoring immediately in Local Mode. No configuration required!

3. Configure Telegram Bot (Optional)

Create Bot & Get Group ID

Message @BotFather on Telegram: /newbot

catops config set telegram.bot_token YOUR_BOT_TOKEN
catops config set telegram.group_id YOUR_GROUP_ID

Get instant alerts via Telegram bot with remote commands.

4. Enable Cloud Mode (Optional)

catops config set cloud.enabled true
catops config set cloud.api_key YOUR_API_KEY

Enable web dashboard at dash.catops.io for online monitoring.

Installation

Multiple ways to install CatOps on your system.

One-Command Installation (Recommended)

curl -sfL https://catops.io/install.sh | bash

One curl command, zero setup hell. This script will automatically:

  • Download the correct binary for your platform
  • Make it executable and add to PATH
  • Create configuration directory
  • Start monitoring service in Local Mode

Quick Installation with Telegram Setup

curl -sfL https://catops.io/install.sh | BOT_TOKEN="your_bot_token" GROUP_ID="your_group_id" sh -

Install with Telegram bot configuration in one command.

Manual Installation

Linux (x86_64)

wget https://releases.catops.io/latest/catops-linux-amd64.tar.gz
tar -xzf catops-linux-amd64.tar.gz
sudo mv catops /usr/local/bin/

macOS

brew install catops

From Source

git clone https://github.com/catops/catops.git && cd catops && go build -o catops ./cmd/catops

Configuration

Configure CatOps to monitor your infrastructure and send alerts.

Quick Start

catops start

Start monitoring immediately in Local Mode. No configuration required!

Telegram Bot Setup

1. Create a Telegram Bot

Message @BotFather on Telegram:

/newbot

Follow the prompts to create your bot and get the bot token.

2. Get Your Group ID

Add your bot to a group, then get the group ID:

curl https://api.telegram.org/bot<YOUR_BOT_TOKEN>/getUpdates

3. Configure CatOps

catops config set telegram.bot_token YOUR_BOT_TOKEN
catops config set telegram.group_id YOUR_GROUP_ID

4. Start with Telegram

catops start --telegram

Cloud Mode (Optional)

For advanced features, web dashboard, and team collaboration, enable Cloud Mode:

1. Get API Key

Visit dash.catops.io to create an account and get your API key.

2. Enable Cloud Mode

catops config set cloud.enabled true
catops config set cloud.api_key YOUR_API_KEY

3. Start with Cloud

catops start --cloud

API Reference

Integrate CatOps with your applications using our REST API.

Get Server Status

GET /api/v1/status

Returns current server metrics and status.

{
  "status": "healthy",
  "cpu_usage": 45.2,
  "memory_usage": 67.8,
  "disk_usage": 23.1,
  "uptime": "7d 14h 32m",
  "last_check": "2025-01-21T10:30:00Z"
}

Send Custom Alert

POST /api/v1/alerts
{
  "title": "Custom Alert",
  "message": "Something important happened",
  "severity": "warning",
  "tags": ["custom", "application"]
}

Need Help?

Can't find what you're looking for? We're here to help.

Community Support

Join our community forum for discussions and help from other users.

Visit Forum →

Email Support

Get direct help from our support team via email.

Contact Support →

Documentation

Browse our comprehensive documentation and guides.

Read Docs →

Ready to start monitoring?

Follow our quick start guide and have CatOps running in minutes.

Get Started Now