commandagi 0.3.0__tar.gz → 0.4.0__tar.gz

commandagi-0.4.0/.gitignore

@@ -0,0 +1,8 @@
+node_modules/
+dist/
+*.tsbuildinfo
+.turbo/
+__pycache__/
+.venv/
+*.egg-info/
+.DS_Store

commandagi-0.4.0/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.5
+Name: commandagi
+Version: 0.4.0
+Summary: The CommandAGI SDK for Python — agent threads, memory and integrations, and live computers, robots and simulated worlds you watch and control.
+Project-URL: Homepage, https://commandagi.com
+Project-URL: Documentation, https://github.com/CommandAGI/commandagi-sdk-python/blob/main/README.md
+Author: CommandAGI
+License: MIT
+Keywords: agents,computer-use,physics,reinforcement-learning,robotics,simulation
+Requires-Python: >=3.9
+Requires-Dist: requests>=2.28
+Requires-Dist: websocket-client>=1.5
+Provides-Extra: gym
+Requires-Dist: gymnasium>=0.29; extra == 'gym'
+Requires-Dist: numpy>=1.23; extra == 'gym'
+Requires-Dist: pillow>=9.0; extra == 'gym'
+Provides-Extra: lerobot
+Requires-Dist: numpy>=1.23; extra == 'lerobot'
+Requires-Dist: pillow>=9.0; extra == 'lerobot'
+Requires-Dist: pyarrow>=14.0; extra == 'lerobot'
+Provides-Extra: vision
+Requires-Dist: numpy>=1.23; extra == 'vision'
+Requires-Dist: pillow>=9.0; extra == 'vision'
+Description-Content-Type: text/markdown
+
+# commandagi — the CommandAGI Python SDK
+
+Drive the whole CommandAGI platform as code: agent threads, memory and integrations, and live
+**embodiments** (cloud computers, robots, simulated worlds) that you watch and control.
+
+```bash
+pip install commandagi
+export COMMANDAGI_API_KEY=cagi_...     # Settings → API keys
+```
+
+```python
+from commandagi import CommandAGI
+
+cagi = CommandAGI()                                   # reads COMMANDAGI_API_KEY
+
+# Agents: start one on a goal and follow along.
+t = cagi.threads.create(intent="Summarise this week's robotics news in five bullets")
+cagi.threads.send(t["threadId"], "Add a link for each one.")
+
+# Embodiments: launch a world YOU drive (no agent in it), watch it, control it.
+with cagi.launch("simulation/warehouse") as world:
+    print(world.controls())                           # what it accepts right now, with payload schemas
+    world.sim.ik(target=[0.3, 0.0, 0.4])              # typed robot/sim control
+    jpeg = world.observe(fresh=True)                  # the next frame, after the move
+# leaving the block stops the world and releases the machine
+
+# Anything else: every platform tool by name.
+cagi.call("list_snapshots")
+```
+
+## One surface, generated
+
+This SDK, the TypeScript SDK (`npm i commandagi`) and the `commandagi` CLI all come from **one
+schema**, `commandagi-sdk.schema.json`, so they can't drift apart:
+
+- **Tools**: `cagi.threads`, `cagi.embodiments`, `cagi.memory`, `cagi.integrations`,
+  `cagi.social(platform, account)`, `whoami`, `search`, `run` and `post`. Each one is a typed wrapper
+  over `call(tool, args)`. Options are passed as keyword arguments, e.g. `snapshot_id=…`, and sent
+  over the wire as camelCase (`snapshotId`).
+- **Control vocabularies** on a live `Session`:
+  - `session.desktop` for computers: `click`, `double_click`, `move`, `scroll`, `type`, `key`, `wait`
+  - `session.robot` for physical robots: `joint`, `gripper`, `move`, `turn`, `home`, `stop`, …
+  - `session.sim` for simulated worlds: `reset`, `sim_mode`, `ctrl`, `actuator`, `ik`,
+    `trajectory`, `grab`, `force`, `add_robot`, …
+
+  Every method sends one action to that embodiment. The platform checks it against the controls the
+  embodiment is currently declaring, which `session.controls()` lists along with their payload
+  schemas. For anything a runtime declares that no vocabulary covers, use `session.act(action,
+  payload)`.
+
+The generated part is `commandagi/_generated.py`. Don't edit it: it is regenerated from the schema in
+the CommandAGI monorepo.
+
+## Sessions
+
+| | |
+| --- | --- |
+| `cagi.launch(snapshot_id, title=, wait=True, timeout=600)` | a new agentless thread running that snapshot; waits until it declares controls |
+| `cagi.session(thread_id, embodiment_id)` | attach to an embodiment that already exists |
+| `session.frame(fresh=False)` / `observe()` / `observe_array()` / `frames()` | the latest frame, as `{url, channel_id, at}`, image bytes, or a numpy array (`pip install "commandagi[vision]"`); `frames()` yields each new one |
+| `session.describe()` | the live world a sim or robot runtime reports |
+| `session.close()` / `stop()` | stop watching / also stop a world this session launched |
+
+Snapshot ids come from `cagi.call("list_snapshots")`, e.g. `simulation/warehouse` or
+`computer/software-engineer`.
+
+## Reinforcement learning
+
+`commandagi.gym_env.CommandAGIEnv` wraps a sim session as a Gymnasium env (`pip install
+"commandagi[gym]"`), and `commandagi.lerobot` records rollouts as LeRobot datasets (`pip install
+"commandagi[lerobot]"`).
+
+## Environment
+
+| variable | meaning |
+| --- | --- |
+| `COMMANDAGI_API_KEY` | your `cagi_…` key. Its scopes decide what every call may do |
+| `COMMANDAGI_BASE_URL` | API origin (default `https://api.commandagi.com`) |
+| `COMMANDAGI_THREAD_ID` | default thread for self-thread methods. Set automatically when your code runs inside the platform |

commandagi-0.4.0/README.md

@@ -0,0 +1,79 @@
+# commandagi — the CommandAGI Python SDK
+
+Drive the whole CommandAGI platform as code: agent threads, memory and integrations, and live
+**embodiments** (cloud computers, robots, simulated worlds) that you watch and control.
+
+```bash
+pip install commandagi
+export COMMANDAGI_API_KEY=cagi_...     # Settings → API keys
+```
+
+```python
+from commandagi import CommandAGI
+
+cagi = CommandAGI()                                   # reads COMMANDAGI_API_KEY
+
+# Agents: start one on a goal and follow along.
+t = cagi.threads.create(intent="Summarise this week's robotics news in five bullets")
+cagi.threads.send(t["threadId"], "Add a link for each one.")
+
+# Embodiments: launch a world YOU drive (no agent in it), watch it, control it.
+with cagi.launch("simulation/warehouse") as world:
+    print(world.controls())                           # what it accepts right now, with payload schemas
+    world.sim.ik(target=[0.3, 0.0, 0.4])              # typed robot/sim control
+    jpeg = world.observe(fresh=True)                  # the next frame, after the move
+# leaving the block stops the world and releases the machine
+
+# Anything else: every platform tool by name.
+cagi.call("list_snapshots")
+```
+
+## One surface, generated
+
+This SDK, the TypeScript SDK (`npm i commandagi`) and the `commandagi` CLI all come from **one
+schema**, `commandagi-sdk.schema.json`, so they can't drift apart:
+
+- **Tools**: `cagi.threads`, `cagi.embodiments`, `cagi.memory`, `cagi.integrations`,
+  `cagi.social(platform, account)`, `whoami`, `search`, `run` and `post`. Each one is a typed wrapper
+  over `call(tool, args)`. Options are passed as keyword arguments, e.g. `snapshot_id=…`, and sent
+  over the wire as camelCase (`snapshotId`).
+- **Control vocabularies** on a live `Session`:
+  - `session.desktop` for computers: `click`, `double_click`, `move`, `scroll`, `type`, `key`, `wait`
+  - `session.robot` for physical robots: `joint`, `gripper`, `move`, `turn`, `home`, `stop`, …
+  - `session.sim` for simulated worlds: `reset`, `sim_mode`, `ctrl`, `actuator`, `ik`,
+    `trajectory`, `grab`, `force`, `add_robot`, …
+
+  Every method sends one action to that embodiment. The platform checks it against the controls the
+  embodiment is currently declaring, which `session.controls()` lists along with their payload
+  schemas. For anything a runtime declares that no vocabulary covers, use `session.act(action,
+  payload)`.
+
+The generated part is `commandagi/_generated.py`. Don't edit it: it is regenerated from the schema in
+the CommandAGI monorepo.
+
+## Sessions
+
+| | |
+| --- | --- |
+| `cagi.launch(snapshot_id, title=, wait=True, timeout=600)` | a new agentless thread running that snapshot; waits until it declares controls |
+| `cagi.session(thread_id, embodiment_id)` | attach to an embodiment that already exists |
+| `session.frame(fresh=False)` / `observe()` / `observe_array()` / `frames()` | the latest frame, as `{url, channel_id, at}`, image bytes, or a numpy array (`pip install "commandagi[vision]"`); `frames()` yields each new one |
+| `session.describe()` | the live world a sim or robot runtime reports |
+| `session.close()` / `stop()` | stop watching / also stop a world this session launched |
+
+Snapshot ids come from `cagi.call("list_snapshots")`, e.g. `simulation/warehouse` or
+`computer/software-engineer`.
+
+## Reinforcement learning
+
+`commandagi.gym_env.CommandAGIEnv` wraps a sim session as a Gymnasium env (`pip install
+"commandagi[gym]"`), and `commandagi.lerobot` records rollouts as LeRobot datasets (`pip install
+"commandagi[lerobot]"`).
+
+## Environment
+
+| variable | meaning |
+| --- | --- |
+| `COMMANDAGI_API_KEY` | your `cagi_…` key. Its scopes decide what every call may do |
+| `COMMANDAGI_BASE_URL` | API origin (default `https://api.commandagi.com`) |
+| `COMMANDAGI_THREAD_ID` | default thread for self-thread methods. Set automatically when your code runs inside the platform |

commandagi-0.4.0/commandagi/__init__.py

@@ -0,0 +1,43 @@
+"""CommandAGI — the Python SDK.
+
+Drive the whole platform as code: agent threads, memory, integrations — and live embodiments
+(computers, robots, simulated worlds) you watch and control.
+
+    from commandagi import CommandAGI
+
+    cagi = CommandAGI()                                   # reads COMMANDAGI_API_KEY
+    cagi.threads.create(intent="Summarise this week's robotics news")
+
+    with cagi.launch("simulation/warehouse") as world:    # a world YOU drive (no agent)
+        world.sim.ik(target=[0.3, 0.0, 0.4])
+        jpeg = world.observe(fresh=True)
+
+The typed surface is generated from the CommandAGI SDK schema (``commandagi-sdk.schema.json``),
+identically for every language; ``call(tool, args)`` reaches any tool.
+"""
+from ._generated import (
+    DEFAULT_BASE_URL,
+    ENV_API_KEY,
+    ENV_BASE_URL,
+    ENV_THREAD_ID,
+    SDK_SCHEMA,
+    DesktopControls,
+    RobotControls,
+    SimControls,
+)
+from .client import CommandAGI, CommandAGIError, Session
+
+__all__ = [
+    "CommandAGI",
+    "CommandAGIError",
+    "Session",
+    "DesktopControls",
+    "RobotControls",
+    "SimControls",
+    "SDK_SCHEMA",
+    "ENV_API_KEY",
+    "ENV_BASE_URL",
+    "ENV_THREAD_ID",
+    "DEFAULT_BASE_URL",
+]
+__version__ = "0.4.0"