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.


Install

pip install cmdop
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")

Terminal

session = server.terminal.create()
server.terminal.send_input(session.session_id, "kubectl get pods\n")
output = server.terminal.get_history(session.session_id)
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

server.files.list("/var/log")
server.files.read("/etc/nginx/nginx.conf")
server.files.write("/tmp/config.json", b'{"key": "value"}')
Method Description
list(path) List dir
read(path) Read file
write(path, content) Write file
delete(path) Delete
copy/move(src, dst) Copy/Move
mkdir(path) Create dir
info(path) Metadata

Agent

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!

Browser

Capability-based API for browser automation.

with client.browser.create_session() as s:
    s.navigate("https://shop.com/products")
    s.dom.close_modal()  # Close popups

    # BeautifulSoup parsing
    soup = s.dom.soup()  # SoupWrapper with chainable API
    for item in soup.select(".product"):
        title = item.select_one("h2").text()
        price = item.attr("data-price")

    # Scrolling with random delays
    for _ in range(10):
        soup = s.dom.soup(".listings")
        s.scroll.js("down", 700)
        s.timing.random(0.8, 1.5)

    # Click with cursor movement
    s.click("button.buy", move_cursor=True)

    # Click all "See more" buttons
    s.input.click_all("See more")

    # Mouse operations
    s.input.mouse_move(500, 300)
    s.input.hover(".tooltip-trigger")

    # JS fetch (bypass CORS, inherit cookies)
    data = s.fetch.json("/api/items")

Core Methods (on session)

Method Description
navigate(url) Go to URL
click(selector, move_cursor) Click element
type(selector, text) Type text
wait_for(selector) Wait for element
execute_script(js) Run JavaScript
screenshot() PNG bytes
get_state() URL + title
get_page_info() Full page info
get/set_cookies() Cookie management

Capabilities

session.scroll - Scrolling

Method Description
js(dir, amount) JS scroll (works on complex sites)
native(dir, amount) Browser API scroll
to_bottom() Scroll to page bottom
to_element(selector) Scroll element into view
info() Get scroll position
infinite(extract_fn) Smart infinite scroll with extraction

session.input - Input operations

Method Description
click_js(selector) JS click (reliable)
click_all(text, role) Click all matching elements
key(key, selector) Press keyboard key
hover(selector) Hover over element (native)
hover_js(selector) Hover via JS
mouse_move(x, y) Move cursor to coordinates

session.timing - Delays

Method Description
wait(ms) Wait milliseconds
seconds(n) Wait seconds
random(min, max) Random delay
timeout(fn, sec, cleanup) Run with timeout

session.dom - DOM operations

Method Description
html(selector) Get HTML
text(selector) Get text content
soup(selector) → SoupWrapper
parse(html) → BeautifulSoup
extract(selector, attr) Get text/attr list
select(selector, value) Dropdown select
close_modal() Close dialogs

session.fetch - HTTP from browser context

Method Description
json(url) Fetch JSON
all(requests) Parallel fetch
execute(method, url, ...) Custom request

SDKBaseModel

Auto-cleaning Pydantic model for scraped data:

from cmdop import SDKBaseModel

class Product(SDKBaseModel):
    __base_url__ = "https://shop.com"
    name: str = ""    # "  iPhone 15  \n" → "iPhone 15"
    price: int = 0    # "$1,299.00" → 1299
    rating: float = 0 # "4.5 stars" → 4.5
    url: str = ""     # "/p/123" → "https://shop.com/p/123"

products = Product.from_list(raw["items"])  # Auto dedupe + filter

Utilities

Logging:

from cmdop import get_logger
log = get_logger(__name__)
log.info("Starting")  # Rich console + auto file logging

TOON Format (30-50% token savings):

from cmdop import json_to_toon, JsonCleaner
toon = json_to_toon({"name": "Alice", "age": 25})
# → "name: Alice\nage: 25"

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.22.tar.gz (158.9 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.22-py3-none-any.whl (267.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cmdop-0.1.22.tar.gz
  • Upload date:
  • Size: 158.9 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.22.tar.gz
Algorithm Hash digest
SHA256 6840ff4166a43c8b3638dca2751b6738f434634cd7c518ecb39f75913fe5bcd6
MD5 cc69f9ff636684f086ba63adb3b1cd3f
BLAKE2b-256 b8fd18d51c135786998eb6a33272cd69d1ca392e462c338eef24b4f792373dd2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cmdop-0.1.22-py3-none-any.whl
  • Upload date:
  • Size: 267.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-0.1.22-py3-none-any.whl
Algorithm Hash digest
SHA256 19e2ac65c0599b74ffbab195d714f6600f5fdb775e9787671f57a38df13f5b26
MD5 7ab73b0b74f1ef5e85c484dead97fb99
BLAKE2b-256 ab98cd9c3850005df3442e453da5d630a87018ce6f00a1aedb6b2707160214d4

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