Skip to main content

Python SDK for CMDOP agent interaction

Project description

cmdop

Any machine. One API.

from cmdop import CMDOPClient

with CMDOPClient.remote(api_key="cmd_xxx") as server:
    server.terminal.execute("docker restart app")
    server.files.write("/etc/nginx/nginx.conf", new_config)
    logs = server.files.read("/var/log/app.log")

No SSH. No VPN. No open ports.


How

Your Code ──── Cloud Relay ──── Agent (on server)
                    │
        Outbound only, works through any NAT/firewall

Agent connects out. Your code connects to relay. Done.


What You Get

Terminal:

session = server.terminal.create()
server.terminal.send_input(session.session_id, "kubectl get pods\n")
output = server.terminal.get_history(session.session_id)

Files:

server.files.list("/var/log")
server.files.read("/etc/nginx/nginx.conf")
server.files.write("/tmp/config.json", b'{"key": "value"}')

Browser — scrape without Selenium/Playwright bullshit:

with server.browser.create_session() as browser:
    browser.navigate("https://shop.com/products")

    # One call → structured data
    products = browser.extract_data(
        ".product-card",
        '{"name": "h2", "price": ".price", "url": {"selector": "a", "attr": "href"}}',
        limit=100
    )["items"]
    # → [{"name": "iPhone", "price": "$999", "url": "/p/123"}, ...]

AI Agent — typed responses:

from pydantic import BaseModel

class Health(BaseModel):
    status: str
    cpu: float
    issues: list[str]

result = server.agent.run("Check server health", output_schema=Health)
health: Health = result.output  # Typed!

Real World

AI Agent + Typed Output:

class DeployResult(BaseModel):
    success: bool
    version: str
    errors: list[str]

result = server.agent.run(
    "Deploy myapp:v2.1, verify containers healthy",
    output_schema=DeployResult
)
if not result.output.success:
    rollback(result.output.errors)

Fleet Update (1000 devices):

async def update_fleet(keys: list[str], config: bytes):
    async with asyncio.TaskGroup() as tg:
        for key in keys:
            tg.create_task(update_one(key, config))

async def update_one(key: str, config: bytes):
    async with AsyncCMDOPClient.remote(api_key=key) as dev:
        await dev.files.write("/etc/app/config.yml", config)
        await dev.terminal.execute("systemctl restart app")

Debug Customer Machine:

with CMDOPClient.remote(api_key=customer_key) as m:
    m.terminal.send_input(sid, "ps aux\n")
    logs = m.files.read("~/Library/Logs/MyApp/error.log")
    m.terminal.send_input(sid, "df -h\n")

Scrape Products:

with client.browser.create_session(headless=True) as b:
    b.navigate("https://amazon.com/s?k=laptop")
    products = b.extract_data(
        ".s-result-item",
        '{"title": "h2", "price": ".a-price-whole"}',
        limit=50
    )["items"]

Install

pip install cmdop

Usage

from cmdop import CMDOPClient, AsyncCMDOPClient

# Remote (via cloud relay)
with CMDOPClient.remote(api_key="cmd_xxx") as client:
    client.files.list("/home")

# Local (direct IPC)
with CMDOPClient.local() as client:
    client.terminal.execute("ls -la")

# Async
async with AsyncCMDOPClient.remote(api_key="cmd_xxx") as client:
    await client.files.read("/etc/hostname")

API

Terminal

Method Description
create(shell) Start session
send_input(id, data) Send commands
get_history(id) Get output
resize(id, cols, rows) Resize
send_signal(id, signal) SIGINT/SIGTERM
close(id) End session

Files

Method Description
list(path) List dir
read(path) Read file
write(path, content) Write file
delete(path) Delete
copy(src, dst) Copy
move(src, dst) Move
mkdir(path) Create dir
info(path) Metadata

Browser

Method Description
create_session(headless) Start browser
navigate(url) Go to URL
click(selector) Click
type(selector, text) Type
wait_for(selector, timeout_ms) Wait
extract(selector, attr) Get text/attr
extract_regex(pattern) Regex matches
validate_selectors(item, fields) Check selectors
extract_data(item, fields, limit) Bulk extract → list[dict]
execute_script(js) Run JS
screenshot() PNG
get_cookies() / set_cookies() Cookies

Scraping workflow:

with client.browser.create_session() as b:
    b.navigate("https://cars.com/listings")

    # 1. Validate (fail fast if site changed)
    v = b.validate_selectors(".item", {"title": "h2", "price": ".price"})
    if not v["valid"]:
        raise Exception(v["errors"])  # also has counts, samples

    # 2. Extract
    cars = b.extract_data(
        ".item",
        '{"title": "h2", "price": {"selector": ".price", "regex": "\\\\d+"}}',
        limit=200
    )["items"]

Agent

Method Description
run(prompt, output_schema) Run agent, get typed result

Types: chat, terminal, command, router, planner


Security

  • TLS everywhere
  • Outbound only — no open ports
  • API key scoping
  • Audit logs

Requirements

  • Python 3.10+
  • CMDOP agent on target

Links

cmdop.com

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-0.1.11.tar.gz (140.7 kB view details)

Uploaded Source

Built Distribution

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

cmdop-0.1.11-py3-none-any.whl (240.2 kB view details)

Uploaded Python 3

File details

Details for the file cmdop-0.1.11.tar.gz.

File metadata

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

File hashes

Hashes for cmdop-0.1.11.tar.gz
Algorithm Hash digest
SHA256 fb508bbf2b81564adf8091fa8586359cf1e6066b026d3bbd7d93448f5eb99927
MD5 b42c2a64438c25fa4773212a6370c23a
BLAKE2b-256 8324a52c3595a8e9890c5bae9f395cd36e32e43659d8ce55a41a18ea69044c83

See more details on using hashes here.

File details

Details for the file cmdop-0.1.11-py3-none-any.whl.

File metadata

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

File hashes

Hashes for cmdop-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 0013e7db28cc56ba33e51e9a991d41a9c4c278ee9f9df3676452ec50ea4b78bc
MD5 eb30c05697a54a75c8d673b54904dea0
BLAKE2b-256 58a0bf5c461b8ff37351eaf40a5b0aae93bf9fbd67532743defd1f6984a49764

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