dejima — Python client
Thin Python client for the Dejima API: run a fleet of AI coding agents on hardware you own.
Alpha (0.x). The API is stable in shape (
v1/-prefixed) but fields may change until1.0. This client is hand-written over the REST surface and mirrorsopenapi.yaml; the only non-generated piece is the PTYSessionhelper.
Install
pip install dejima-sdk # REST client
pip install 'dejima[ws]' # + WebSocket PTY attach()
Quickstart
from dejima import Client
# host/token from $DEJIMA_HOST and $DEJIMA_TOKEN, or pass explicitly:
dj = Client(host="100.84.12.7:7273")
isl = dj.create_island(repo="git@github.com:you/foo.git", agent="claude-code")
print(isl["name"], isl["state"])
# add a second agent on its own worktree
dj.add_agent(isl["name"], type="codex")
# one-shot command
out = dj.exec(isl["name"], ["git", "status", "--short"])
print(out["stdout"], "exit", out["exit_code"])
# fleet view
for i in dj.list_islands():
print(i["name"], i["state"], len(i.get("agents", [])), "agents")
print(dj.overview()) # daemon health, VM memory, rollup
Interactive sessions
attach() opens the multi-attach PTY stream (needs the ws extra). The daemon
speaks a small JSON-envelope protocol over the WebSocket — Session hides that,
so you deal in raw bytes:
with dj.attach(isl["name"]) as s: # or agent="p2"
s.resize(40, 120)
s.send(b"ls -la\n")
print(s.recv()) # bytes of PTY output, or None when closed
dj.attach_terminal("t1") does the same for an operator host terminal.
API coverage
The client covers the full v1 surface:
- Islands — list/create/get/update/delete, hibernate/wake/reset/upgrade, clone, resources, workspace-ready, events.
- Agents — list/add/get/update/remove, configure (provider/model).
- Exec & files — exec, file read/write, logs.
- Port broker — scopes (list/grant/revoke), intake/export/write.
- Capability broker — grants (list/grant/revoke), execute.
- MCP broker — grants (list/grant/revoke),
mcp_call. - Credentials — Claude push/status, GitHub identities + repos, LLM providers.
- Operator tokens — create/list/revoke (owner-only; role + island scope).
- Events — webhook subscribe/list/unsubscribe.
- Activity — team activity feed (
activity, filterable). - Daemon — overview, agent-types, healthz, audit (filters + jsonl/csv export), clients, sessions-revoke, panic, admin-update, image-build, SSH account keys.
- Host terminals — list/create/delete/relabel +
attach_terminal. - Sessions —
attach/attach_terminal(PTY) andsession_url.
Every non-2xx response raises dejima.DejimaError (.status, .message).
Auth
- Operator (unix socket / tailnet) needs no token.
- Autonomy path (an agent driving its own/child islands) uses a per-island
bearer token — set
DEJIMA_TOKENor passtoken=.
Development
pip install -e '.[dev]'
pytest
Tests run against a stdlib http.server stub — no running daemon required.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file dejima_sdk-0.8.62.tar.gz.
File metadata
- Download URL: dejima_sdk-0.8.62.tar.gz
- Upload date:
- Size: 14.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
824878c274d28984e8862d186dbc1f2660247acaadfa6c037bc9eddc4fe652a0
|
|
| MD5 |
1c59a3ccdac52dafcf1641e52313d805
|
|
| BLAKE2b-256 |
8800192522476f8b2456f65d949db65ae7d8489b97375d974b63c9bfc28bbd38
|
File details
Details for the file dejima_sdk-0.8.62-py3-none-any.whl.
File metadata
- Download URL: dejima_sdk-0.8.62-py3-none-any.whl
- Upload date:
- Size: 11.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b71734ee08f555af92c60bf5ce0b11fc8dd94bb72b3d5c4eb0cc554005292921
|
|
| MD5 |
a077877cadee0b599ba904a9e2be1892
|
|
| BLAKE2b-256 |
1c6402d33d1915100d6df0c52926e3f2f7dde926a9d70d52a5ffa87ca5028254
|
