Metadata-Version: 2.1
Name: pycodex-ws
Version: 0.7.0
Summary: Browser workspace and optional Feishu integration for python-codex
License-File: LICENSE
Requires-Python: >=3.7
Requires-Dist: pillow>=9.0.0
Requires-Dist: python-codex==0.7.0
Requires-Dist: websockets<16,>=11
Description-Content-Type: text/markdown

# pycodex-ws

Browser conversations, a live HTML Canvas, read-only file/diff viewers and
optional Feishu integration for
[`python-codex`](https://pypi.org/project/python-codex/).
Requires Python 3.7+ and installs the matching core version.

For changes since 0.6.0 and Python integration updates, see the
[0.7.0 release notes](https://github.com/Randomizez/pycodex/blob/v0.7.0/docs/RELEASE_0.7.0.md).

## Quick start

```bash
python3 -m pip install pycodex-ws
```

Create `workspaces.json`:

```json
{
  "workspaces": [
    {"id": "demo", "work_dir": ".", "state_path": "demo", "enable_board": true}
  ]
}
```

```bash
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. Click × and
confirm to close a session; the last session stays open. 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.

Use **New session** for the default profile, or its **+** button to choose one.
Profiles reload when you open the chooser or create a session, so config changes
apply to new sessions without restarting the server. Existing sessions keep their configuration.

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)`. A Markdown link such as
`[source](file:///data/project/app.py#L42-L48)` opens the workspace file at line 42.
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](../../docs/RUNTIME.md#workspace-content-views).

With embedded VS Code enabled, clicking a file or diff link opens it in the
current browser tab's workbench. You can open the same folder in several tabs
and use each editor independently. Git comparisons display symbolic links as
their target paths. VS Code handles large files using its own editor limits.

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](workspace_server/WORKSPACE_API.md#commands-and-results).

The [VS Code extension](extensions/vscode/README.md) uses this backend and is
distributed separately as a VSIX.

## Customize the interface

Choose **Settings → Customize Agent** from the conversation header to open a
conversation and the
[optional feature catalog](workspace_server/optional_features/README.md), with
a **Customize Agent** banner at the top of the chat for reopening the catalog,
switching to `?builtin=1`, copying the frontend directory or opening `WORKSPACE_API.md`.
Browse the feature descriptions, then send a feature name, ID or your own
interface request in chat. The Agent starts with that message.
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.

The frontend build embeds the page styles and JavaScript in the packaged `workspace.html`.
Once the updated files are on the server, refresh the browser to load the new interface.

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](../../docs/RUNTIME.md#frontend-customization).
For custom interfaces, the [resource API](../../docs/WORKSPACE_API.md) 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, banner (`host.setBanner`)
and view controls, and host wrappers can embed `<script type="application/json" data-pycodex-banner>` banners.

Backend module ownership and the preserved session interfaces are documented in
the [runtime guide](../../docs/RUNTIME.md#workspace-session-api).
File/Git source resolution and view storage retain their existing public classes;
see [content views](../../docs/RUNTIME.md#workspace-content-views).

The Agent adapts the selected feature's source into your frontend.
To share a local change, ask it to publish a
feature PR on GitHub; the [contribution guide](workspace_server/optional_features/CONTRIBUTING.md)
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.

## External Call

Open **Settings → External Call**, pick a profile and click
**Create session**. The workspace selects the new conversation and pins an
**External Call** banner at the top of the chat with **Copy Bash**,
**Copy PowerShell** and expandable **Details** for the full commands and
endpoint URL. Copy the command for your client machine and run it in a terminal.

Send the task from the Web conversation. External Call sessions inject
contextual guidance distinguishing the host workspace machine (`exec_command`
and other standard tools, `<environment_context>`, `AGENTS.md`, skills) from the
connected client machine (`client_exec_command`). The terminal prints each
command and its output, and returns the output and exit status to the
conversation. The Bash and PowerShell commands are client examples over the
session's `b/<code>` HTTP endpoint; custom scripts or executables (such as Python
or `cmd`) can pull commands with `GET` and return results with `POST` or `GET`.

Each new session gets its own connection code. Closing its tab invalidates that
code, releases pending requests and stops the terminal loop. After a server
restart, create a new session to reconnect a terminal. Previous conversations
retain their recorded history.

## 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](../../docs/RUNTIME.md).

## Feishu

Install the optional SDK in the workspace's Python environment, then authorize:

```bash
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](../../docs/RUNTIME.md#feishu-connection-lifecycle)
and [event presentation](../../docs/RUNTIME.md#observation).

## Development

From the repository root:

```bash
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](../../docs/RUNTIME.md) and
[test documentation](../../tests/TESTS.md).
