optio-opencode
Run opencode web as an optio task — local subprocess or remote over SSH — with opencode's UI reachable through optio's UI components.
What it does
Given an OpencodeTaskConfig (workdir contents, prompt, deliverable callback), optio-opencode:
- Provisions a fresh workdir on the chosen host (local or remote).
- Writes
AGENTS.md(base prompt + your instructions) andopencode.json(your config) into it. - Installs the opencode binary if missing (remote mode only).
- Launches
opencode webwith a random auth password. - Registers the opencode UI as a widget that optio's UI components can embed via the widget proxy — SSH tunnel hidden from optio-api.
- Tails a log file the LLM writes to and translates structured lines into optio events:
STATUS: …→ctx.report_progress(percent, message)DELIVERABLE: <path>→ fetches the file, invokes youron_deliverablecallbackDONE [summary]→ clean completionERROR [message]→ failure
- Cleans up workdir and SSH connection on teardown.
The same OpencodeTaskConfig works for local and remote modes; only SSHConfig differs.
When to use it
You want an opencode-driven assistant session as a managed optio task — surfaced through optio's UI, with progress reporting and file deliverables — without writing the host management, log parsing, or widget plumbing yourself.
Installation
pip install optio-opencode
Python 3.11+. Depends on optio-core, optio-host, and asyncssh.
Minimal example
from optio_opencode import create_opencode_task, OpencodeTaskConfig
from optio_host import SSHConfig
config = OpencodeTaskConfig(
workdir_files={"AGENTS.md": "Do the thing.", "opencode.json": "{...}"},
on_deliverable=lambda ctx, path, text: print(f"got {path}: {len(text)} bytes"),
ssh=SSHConfig(host="worker-1", user="optio", key_path="~/.ssh/id_optio"),
)
task = create_opencode_task(config)
# Schedule / run via optio-core as usual.
Set ssh=None for local subprocess mode.
Messages
use_client_messages(bool, defaultFalse) — enable theCLIENT_MESSAGE:log keyword: the agent can push{keyword, data}messages to the browser session that launched the task (surfaced via optio-ui'sonClientMessage).on_caller_message(async callback, defaultNone) — enable theCALLER_MESSAGE:log keyword: the agent can push{keyword, data}messages to your application. Signature(hook_ctx, keyword, data) -> str | None; a non-None return is sent back to the agent as feedback. Keywords that are not enabled are absent from both the parser and the agent-facing protocol documentation.
License
Apache-2.0.
Metadata
Release files for optio-opencode 0.6.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| optio_opencode-0.6.4.tar.gz | 126.7 kB | Without provenance | Details for optio_opencode-0.6.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| optio_opencode-0.6.4-py3-none-any.whl | Python 3 | none | any | Details for optio_opencode-0.6.4-py3-none-any.whl |
Total release size: 192.4 kB
Release files / optio_opencode-0.6.4.tar.gz
| Download URL | optio_opencode-0.6.4.tar.gz |
|---|---|
| Size | 126.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ed1839bbaec91ae685be0778d1a4f7ac723fe6e989505e74c439b5f38ac05d7a
|
|
BLAKE2b-256 checksum How to use checksums |
86aa202d41bddbbc1a7059d4e619f5bd904f6177ebf2ed3feca3c95b46ee0cef
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.5
|
Release files / optio_opencode-0.6.4-py3-none-any.whl
| Download URL | optio_opencode-0.6.4-py3-none-any.whl |
|---|---|
| Size | 65.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4393747f5f21568f07bc4ffa9ffe6569bab23629d00b50b54cba1af49e79a023
|
|
BLAKE2b-256 checksum How to use checksums |
4cdb0f73e9b3da426a8a9bc3561acdae4f7d45d393b2f329094260574d23972c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.5
|
Security for optio-opencode 0.6.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.