SDK Overview

Install

Both packages bundle the Cmdop core for supported macOS, Linux, and Windows hosts. The client starts it on demand and communicates with it over stdio.

Supported hosts

Each package ships every supported host binary, so one install covers them all:

There is no separate Cmdop core download or install step, and the package does not fetch a runtime on first use.

Dependencies

Each package has exactly one runtime dependency: protobuf (>= 7.35.1) for Python, @bufbuild/protobuf (^2.12.0) for Node. Neither client pulls in an HTTP library or any other transitive framework.

Local-first setup

Use Client() with no arguments for the active local Cmdop setup. The core discovers the configured relay and matching credentials.

from cmdop import Client
 
async with Client() as client:
    bootstrap = await client.system.bootstrap()
    snapshot = await client.machines.list()
 
    for machine in snapshot.machines:
        print(machine.machine_id, machine.display_name)

Use CMDOP_BASE_URL with CMDOP_TOKEN when you intentionally target a remote relay. See Configuration.

Shipped surface

Python and Node expose the same capabilities. Python uses snake_case fields; Node uses camelCase fields and options.