cmdop 0.1.0

Python SDK for CMDOP agent interaction

cmdop

Python SDK for CMDOP — remote terminal and file management for your machines.

Installation

pip install cmdop

Quick Start

from cmdop import CMDOPClient

with CMDOPClient.remote(api_key="cmdop_live_xxx") as client:
    # Terminal
    session = client.terminal.create()
    client.terminal.send_input(session.session_id, "ls -la\n")

    # Files
    files = client.files.list("/home")
    content = client.files.read("/etc/hostname")

Features

Feature	Description
Remote Mode	Connect via cloud relay (grpc.cmdop.com)
Local Mode	Direct IPC with local agent (Unix socket)
Sync & Async	Both CMDOPClient and AsyncCMDOPClient
Terminal	Create sessions, send input, resize, signals
Files	List, read, write, copy, move, delete
Type Safe	Full Pydantic v2 models

Connection Modes

# Remote — via cloud relay
client = CMDOPClient.remote(api_key="cmdop_live_xxx")

# Local — direct to agent
client = CMDOPClient.local()

Async Usage

import asyncio
from cmdop import AsyncCMDOPClient

async def main():
    async with AsyncCMDOPClient.remote(api_key="cmdop_live_xxx") as client:
        session = await client.terminal.create()
        await client.terminal.send_input(session.session_id, "whoami\n")

        files = await client.files.list("/tmp")

asyncio.run(main())

API Reference

Terminal Service

Method	Description
create(shell, cols, rows)	Create terminal session
send_input(session_id, data)	Send input to terminal
resize(session_id, cols, rows)	Resize terminal
send_signal(session_id, signal)	Send signal (SIGINT, etc.)
get_history(session_id, lines)	Get output history
close(session_id)	Close session

Files Service

Method	Description
list(path, limit, offset)	List directory contents
read(path)	Read file contents
write(path, content)	Write file
delete(path, recursive)	Delete file or directory
copy(src, dst)	Copy file
move(src, dst)	Move/rename file
mkdir(path, parents)	Create directory
info(path)	Get file metadata

Error Handling

from cmdop import CMDOPClient
from cmdop.exceptions import (
    AgentOfflineError,
    AuthenticationError,
    SessionNotFoundError,
    FileNotFoundError,
)

try:
    client = CMDOPClient.remote(api_key="cmdop_live_xxx")
    client.terminal.create()
except AuthenticationError:
    print("Invalid API key")
except AgentOfflineError:
    print("Agent not connected")

Configuration

from cmdop import CMDOPClient
from cmdop.models import ConnectionConfig, KeepaliveConfig

config = ConnectionConfig(
    connect_timeout_seconds=10.0,
    request_timeout_seconds=30.0,
    keepalive=KeepaliveConfig(time_ms=10_000, timeout_ms=5_000),
)

client = CMDOPClient.remote(api_key="cmdop_live_xxx", config=config)

Requirements

• Python 3.10+
• grpcio, protobuf
• pydantic v2
• httpx

License

MIT