pycodex-ws
Browser conversations, a live HTML Canvas, read-only file/diff viewers and
optional Feishu integration for
python-codex.
Requires Python 3.7+ and installs the matching core version.
Quick start
python3 -m pip install pycodex-ws
Create workspaces.json:
{
"workspaces": [
{"id": "demo", "work_dir": ".", "state_path": "demo", "enable_board": true}
]
}
pycodex-ws --listen 127.0.0.1:6007 --workspace-config workspaces.json
Open http://127.0.0.1:6007. Use python3 -m workspace_server if the command
is not on PATH. Keep stdin open while the server runs; EOF initiates shutdown.
Model configuration comes from ~/.codex/config.toml.
Conversations and views
The session sidebar starts collapsed. Hover to preview it, click to keep it open, and click the toggle or empty space again to close it. Expansion narrows the conversation while keeping the board fixed. On phones, use the header buttons to switch between chat and board.
Use the expanded sidebar to create, rename or close sessions. Status dots show
running sessions and unread replies. /cd <directory> changes the current
session's working directory while idle; /model, /resume, /compact and
other core session commands are also available.
Consecutive model reconnection diagnostics share one collapsed Model retries
row per sequence. The summary shows the number of recorded retries, the latest
attempt and its HTTP status when available. Expand it to read the original errors
in a scrollable log. New retries update the same row and preserve its open state;
refreshing starts collapsed. Other model diagnostics and final errors stay visible.
Click Markdown links to open files and comparisons, for example
[source](app.py:42) or [changes](diff:HEAD:app.py). In a code or diff view,
select text and choose Insert into chat to add editable context to the draft.
Click a context block to edit or remove it before sending.
See view links and supported formats.
When using a router, its directory groups workspaces by device and lists unread workspaces at the top. Device handles reorder the list; pencil buttons edit device names.
The VS Code extension uses this backend and is distributed separately as a VSIX.
Customize the interface
Click the gear button and choose Frontend customization to start a
customization conversation with the Agent.
Custom files live in the server user's ~/.pycodex/frontend/:
custom.cssandcustom.js: optional styles and an ES module, loaded automatically.workspace.html: optional full-page override; otherwise the packaged page is used.- Other files: available at workspace-relative
frontend/<path>URLs.
Refresh to apply changes and keep the selected conversation. Open the workspace
with ?builtin=1 to bypass all customizations; click “Re-enable customizations”
to return. Changes apply to all workspaces for that OS user.
See the customization contract.
For custom interfaces, the resource API exposes
state, model catalogs, asynchronous command results, paginated history, event
replay and sub-agent/background-work inventories. A mount(host) export in
custom.js can access the built-in page's session, draft and view controls.
Ask the Agent to show the feature catalog in the view area, then choose features by name or ID in chat. The Agent adapts their source into your frontend. To share a local change, ask it to publish a feature PR on GitHub; the contribution guide specifies the source, documentation, validation and PR format.
Share a workspace
Start the workspace server with an administrator password (--password), then
choose Settings → Share in a workspace. Set a different share password and
send the displayed workspace link and password to the recipient.
The existing login page accepts either the administrator password or the share password for the workspace being opened. Visitors can use all its conversations, Canvas, files, APIs and WebSocket connections, but cannot access workspace management, another workspace or sharing settings. The settings button and management navigation are hidden for visitors.
Passwords, verification values and visitor tokens are kept only in process memory. Changing the password or stopping sharing invalidates existing visitor logins and disconnects their WebSockets. Restarting the process clears all shares. Already accepted Agent work continues.
This restricts web access; Agent tools retain their existing file and execution permissions. An unprotected server must configure its administrator password before enabling sharing. Router authentication is unchanged: a link through a router still requires its normal login.
Storage
Paths in workspaces.json resolve from the configuration directory.
state_path is a unique filename prefix: the example saves sessions in
demo.pycodex-ws.json, file views in demo.pycodex-views.json, and Canvas in
demo.html. Suffixes are appended to the complete prefix, including any dots.
Set enable_board to false to disable Canvas while retaining conversations
and file views. Session directories and history survive server restarts;
changing a session's directory does not move Canvas or workspace state files.
Configuration and restoration details are in the runtime guide.
Feishu
Install the optional SDK in the workspace's Python environment, then authorize:
python3 -m pip install lark-oapi
python3 -m pycodex_ws.feishu_oauth
Authorization reads app credentials from ~/.codex/.env and stores the refresh
token in ~/.codex/.feishu_refresh_token. In a workspace session, use
/link <feishu-email|open_id|chat_id> to connect a card and /unlink to disconnect.
Other workspace features work without the SDK.
Development
From the repository root:
uv sync --dev
uv run pycodex-ws --help
uv run --dev pytest packages/pycodex-ws/tests
uv build packages/pycodex-ws
Python integrations use pycodex_ws.build_runtime(agent) to include workspace
commands. See runtime contracts and
test documentation.
Metadata
Release files for pycodex-ws 0.5.2
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 |
|---|---|---|---|---|
| pycodex_ws-0.5.2.tar.gz | 1.8 MB | With provenance | Details for pycodex_ws-0.5.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pycodex_ws-0.5.2-py3-none-any.whl | Python 3 | none | any | Details for pycodex_ws-0.5.2-py3-none-any.whl |
Total release size: 3.6 MB
Release files / pycodex_ws-0.5.2.tar.gz
| Download URL | pycodex_ws-0.5.2.tar.gz |
|---|---|
| Size | 1.8 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2565e60ca2b4499c405c333c8d182b5a3ea174ad6ee13e262e93d25153ab65ed
|
|
BLAKE2b-256 checksum How to use checksums |
49dd079e58682906c560885275f7dedc2a957a012e6e259fadaf4ff1bda06472
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 28, 2026.
Transparency logRelease files / pycodex_ws-0.5.2-py3-none-any.whl
| Download URL | pycodex_ws-0.5.2-py3-none-any.whl |
|---|---|
| Size | 1.8 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
20dc70a363a1b6923a47f0c8e8d94cdd1d74428eeaa7b296fdaf8b1fef697160
|
|
BLAKE2b-256 checksum How to use checksums |
a03ac54d3551d8b09531596e1879f8dfc2b3ff0f2ef03352f9e1da66a1a13488
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 28, 2026.
Transparency logSecurity for pycodex-ws 0.5.2
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.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for pycodex_ws-0.5.2.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 28, 2026.
Transparency logA 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.