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.

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.

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 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.

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.1

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.5.1
File Size Uploaded Provenance Actions
pycodex_ws-0.5.1.tar.gz 1.4 MB With provenance Details for pycodex_ws-0.5.1.tar.gz

Built distribution (wheel)

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

Total release size: 2.7 MB

Release files / pycodex_ws-0.5.1.tar.gz

Download URL pycodex_ws-0.5.1.tar.gz
Size 1.4 MB
Tags Source
SHA-256 checksum
How to use checksums
910ea949de3cd7fc999467589e1b13ba86a384d7d74b3e0cae9377164d16d293
BLAKE2b-256 checksum
How to use checksums
a26e5e9b17c4e7aeda4b14144b0f37d61ab6eb860536807321f56fb466f60a47
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 22, 2026.

Transparency log

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

Download URL pycodex_ws-0.5.1-py3-none-any.whl
Size 1.3 MB
Tags Python 3
SHA-256 checksum
How to use checksums
04517c18376e27ef3de39b413b301cea9434fe1ebd8731544a774740416111cf
BLAKE2b-256 checksum
How to use checksums
8d5c74ba4ef6683fb3223aa8ac07e231c81f758258d11a88de325e7bc9a577f3
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 22, 2026.

Transparency log

Security for pycodex-ws 0.5.1

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.5.1.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 22, 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