Skip to main content

CMDOP Bot - Multi-channel bot integrations for remote machine access

Project description

CMDOP Bots

Multi-channel bot integrations for remote machine access.

Control your servers via Telegram, Discord, or Slack. Simple, reliable, open-source.

Install

pip install cmdop-bot

# With Telegram support
pip install cmdop-bot[telegram]

# With Discord support
pip install cmdop-bot[discord]

# With Slack support
pip install cmdop-bot[slack]

# With all channels
pip install cmdop-bot[all]

Quick Start

Telegram Bot

from cmdop_bots.channels.telegram import TelegramBot

bot = TelegramBot(
    token="YOUR_TELEGRAM_BOT_TOKEN",
    cmdop_api_key="YOUR_CMDOP_API_KEY",
    allowed_users=[123456789],  # Your Telegram user ID
    machine="my-server",  # Optional: target machine
)

bot.run()

Discord Bot

from cmdop_bots.channels.discord import DiscordBot

bot = DiscordBot(
    token="YOUR_DISCORD_BOT_TOKEN",
    cmdop_api_key="YOUR_CMDOP_API_KEY",
    guild_ids=[123456789],  # Optional: for faster command sync
)

bot.run()

Slack App

from cmdop_bots.channels.slack import SlackApp

app = SlackApp(
    bot_token="xoxb-YOUR-BOT-TOKEN",
    app_token="xapp-YOUR-APP-TOKEN",
    cmdop_api_key="YOUR_CMDOP_API_KEY",
)

app.run()

Commands

Channel Command Description
Telegram /shell <cmd> Execute shell command
Telegram /exec <cmd> Alias for /shell
Telegram /agent <task> Run AI agent task
Telegram /ls [path] List directory
Telegram /cat <path> Read file
Telegram /machine <host> Set target machine
Discord /shell <cmd> Execute shell command
Discord /agent <task> Run AI agent task
Discord /ls [path] List directory
Discord /cat <path> Read file
Discord /machine <host> Set target machine
Discord /status Show connection status
Slack /cmdop shell <cmd> Execute shell command
Slack /cmdop agent <task> Run AI agent task
Slack /cmdop ls [path] List directory
Slack /cmdop cat <path> Read file
Slack /cmdop machine <host> Set target machine
Slack /cmdop status Show connection status

Features

Telegram

  • MarkdownV2 formatting
  • Code block syntax highlighting
  • Typing indicators
  • User allowlist

Discord

  • Slash commands
  • Rich embeds
  • Ephemeral messages for sensitive data
  • Deferred responses for slow operations
  • Guild-specific command sync

Slack

  • Socket Mode (no public webhooks needed)
  • Block Kit messages
  • Interactive buttons
  • Slash command handling

Handlers

Use handlers directly in your own bot:

from cmdop_bots.handlers import ShellHandler, AgentHandler, FilesHandler

# Create handlers
shell = ShellHandler(cmdop_api_key="cmd_xxx", machine="my-server")
agent = AgentHandler(cmdop_api_key="cmd_xxx")
files = FilesHandler(cmdop_api_key="cmd_xxx")

# Use in your handler
async def handle_command(command, send):
    await shell.handle(command, send)

# Clean up
await shell.close()
await agent.close()
await files.close()

Permissions

Control who can use your bot:

from cmdop_bots import PermissionManager, PermissionLevel

pm = PermissionManager()

# Add admin (full access)
pm.add_admin("telegram:123456789")

# Grant execute permission
pm.grant("discord:987654321", machine="prod-server", level=PermissionLevel.EXECUTE)

# Use with bot
bot = TelegramBot(
    token="...",
    cmdop_api_key="...",
    permissions=pm,
)

Architecture

+--------------+
|  Telegram    |
|  Discord     |------> CMDOP SDK ------> Your Servers
|  Slack       |
+--------------+
  • Simple: Each bot is < 200 lines of code
  • Reliable: Proper error handling, reconnection
  • Secure: Permission system, user allowlists

Development

# Clone repository
git clone https://github.com/cmdop/cmdop-bot
cd cmdop-bot

# Install dev dependencies
pip install -e ".[dev,all]"

# Run tests
pytest

# Type check
mypy cmdop_bots

# Lint
ruff check cmdop_bots

Environment Variables

Variable Description Required
TELEGRAM_BOT_TOKEN Telegram bot token For Telegram
DISCORD_BOT_TOKEN Discord bot token For Discord
SLACK_BOT_TOKEN Slack bot token (xoxb-...) For Slack
SLACK_APP_TOKEN Slack app token (xapp-...) For Slack
CMDOP_API_KEY CMDOP API key (cmd_xxx) Yes
CMDOP_MACHINE Default target machine No
ALLOWED_USERS Comma-separated user IDs No

Examples

See the examples/ directory:

  • telegram_bot.py - Full Telegram bot example
  • discord_bot.py - Full Discord bot example
  • slack_app.py - Full Slack app example
  • multi_channel.py - Multi-channel hub example

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cmdop_bot-0.1.1.tar.gz (22.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cmdop_bot-0.1.1-py3-none-any.whl (37.3 kB view details)

Uploaded Python 3

File details

Details for the file cmdop_bot-0.1.1.tar.gz.

File metadata

  • Download URL: cmdop_bot-0.1.1.tar.gz
  • Upload date:
  • Size: 22.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.18

File hashes

Hashes for cmdop_bot-0.1.1.tar.gz
Algorithm Hash digest
SHA256 a06f6787d61afd6cededa6d1fc61063849191992c531ecee9515ba98c90df733
MD5 d43e81e64e763eba3d862ac4f79eba0b
BLAKE2b-256 484447ad2f021558bc42d51cb9df8cf61a11b98f6fb0831094e4b1adff0d4b03

See more details on using hashes here.

File details

Details for the file cmdop_bot-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: cmdop_bot-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 37.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.18

File hashes

Hashes for cmdop_bot-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9d63640d8ff67a96931d4a2f2d6bb894b42a42983651eefebb49c73395ace4ff
MD5 9838bfe62b571c9e92b2a07008d75a01
BLAKE2b-256 b08a224b3122f723f291b3a708c27bd24d486e92e85ed51efe81d195a40c8dbf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page