Skip to main content

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.

See the 0.6.0 release notes for changes and integration migration from 0.5.0.

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 runtime information shared between Agents recommends plain messages, which steer active work at the next safe boundary. Use /queue explicitly for an independent follow-up task that should wait for current work to finish.

The message API also accepts a string name, defaulting to "user", for identifying the source of a user message. The history API returns it, and recorded sessions preserve it across resume. It is metadata only: the model request and frontend display do not include it. See the message API contract.

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.css and custom.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.

Backend module ownership and the preserved session interfaces are documented in the runtime guide. File/Git source resolution and view storage retain their existing public classes; see content views.

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.

The adapter separates card rendering, refresh-token storage and SDK connections. PycodexCard and PycodexRuntimeLink keep their existing imports and interfaces; see connection lifecycle and event presentation.

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 construct a runtime through AgentsManager.create_root_runtime() and call pycodex_ws.register_feishu_commands(runtime) to include /link and /unlink. The context indicator shows tokens against the auto-compaction limit; its expandable Agent tree shows each task's status and latest assistant text. See runtime contracts and test documentation.

Metadata

Release files for pycodex-ws 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pycodex-ws 0.6.0
File Size Uploaded Provenance Actions
pycodex_ws-0.6.0.tar.gz 1.9 MB With provenance Details for pycodex_ws-0.6.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pycodex-ws 0.6.0
File Interpreter ABI Platform Actions
pycodex_ws-0.6.0-py3-none-any.whl Python 3 none any Details for pycodex_ws-0.6.0-py3-none-any.whl

Total release size: 3.7 MB

Release files / pycodex_ws-0.6.0.tar.gz

Download URL pycodex_ws-0.6.0.tar.gz
Size 1.9 MB
Tags Source
SHA-256 checksum
How to use checksums
22dc87b8b2bd203ee343d3624b93a6390660df6d4a3b5d96bfb9ad797563b6eb
BLAKE2b-256 checksum
How to use checksums
b611747c603e10aae53ed330cd35561db4c41bd106c90d02f94e07aae21d92dd
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 31, 2026.

Transparency log

Release files / pycodex_ws-0.6.0-py3-none-any.whl

Download URL pycodex_ws-0.6.0-py3-none-any.whl
Size 1.9 MB
Tags Python 3
SHA-256 checksum
How to use checksums
11088b92d4e40da7e51f09894871038db14217d4c913cdde4569eb9cc2e80a5c
BLAKE2b-256 checksum
How to use checksums
a001c3f8e61d7feaf4a50c64a560c9ae6a0efb06708ce4d664303e26bdf250c3
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 31, 2026.

Transparency log

Security for pycodex-ws 0.6.0

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.

Select from 2 files

Attestation for pycodex_ws-0.6.0.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 31, 2026.

Transparency log

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page