plural-agent 0.1.0__tar.gz

plural_agent-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: ci
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  python:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.12"
+      - run: uv sync --frozen
+      - run: uv run ruff check .
+      - run: uv run ruff format --check .
+      - run: uv run pyright
+      - run: uv run lint-imports
+      - run: uv run python scripts/gen_schema.py --check
+      - run: uv run coverage run -m pytest && uv run coverage report
+      - run: uv run pip-audit
+

plural_agent-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,52 @@
+name: release
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.12"
+      - name: Check tag matches package version
+        run: |
+          version=$(sed -n 's/^__version__ = "\(.*\)"/\1/p' src/plural/__init__.py)
+          test "v${version}" = "${GITHUB_REF_NAME}"
+      - run: uv sync --frozen
+      - run: uv run pytest
+      - run: uv build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    needs: publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true

plural_agent-0.1.0/.gitignore

@@ -0,0 +1,81 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+*.egg
+*.egg-info/
+.eggs/
+build/
+dist/
+wheels/
+sdist/
+pip-wheel-metadata/
+*.manifest
+*.spec
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+.python-version
+
+# Tooling caches
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.pyright/
+.hypothesis/
+.import_linter_cache/
+.tox/
+.nox/
+.cache/
+
+# Coverage
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/
+*.cover
+
+# Secrets and local config
+.env
+.env.*
+!.env.example
+*.pem
+*.key
+secrets/
+
+# Plural runtime data
+.plural/
+*.sqlite
+*.sqlite-wal
+*.sqlite-shm
+*.db
+*.db-wal
+*.db-shm
+session*.jsonl
+*.log
+
+# Web
+web/node_modules/
+web/dist/
+web/.vite/
+web/src/protocol/types.ts
+npm-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# Editors and OS
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+.DS_Store
+Thumbs.db
+
+# Local agent notes
+.claude/
+CLAUDE.local.md

plural_agent-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,8 @@
+# Contributing
+
+- Sign off every commit (`git commit -s`), we use the [DCO](https://developercertificate.org/).
+- Conventional Commits, small PRs.
+- Respect layer contracts (`uv run lint-imports`): `protocol` and `core` do no I/O, `relay` never decides permissions.
+- Every tool call goes through `PolicyGate`. No bypasses, not even temporary ones.
+- Protocol change: models → `uv run python scripts/gen_schema.py` → `docs/protocol.md` → golden fixtures.
+- New behaviour ships with tests; harness tests use `FakeProvider`.

plural_agent-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

plural_agent-0.1.0/PKG-INFO

@@ -0,0 +1,316 @@
+Metadata-Version: 2.5
+Name: plural-agent
+Version: 0.1.0
+Summary: Multiplayer sessions for one AI agent: shared context, host approvals, attribution, isolation.
+Project-URL: Homepage, https://github.com/Plural-Organization/Plural
+Project-URL: Issues, https://github.com/Plural-Organization/Plural/issues
+Project-URL: Changelog, https://github.com/Plural-Organization/Plural/releases
+Author: Plural team
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agent,ai,coding-agent,llm,multiplayer,tui
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development
+Requires-Python: >=3.12
+Requires-Dist: aiosqlite>=0.21
+Requires-Dist: anthropic>=2.3.0
+Requires-Dist: cryptography>=44
+Requires-Dist: openai>=3.37.0
+Requires-Dist: pydantic-settings>=2.8
+Requires-Dist: pydantic>=2.11
+Requires-Dist: rich>=13.9
+Requires-Dist: starlette>=0.46
+Requires-Dist: structlog>=25.1
+Requires-Dist: textual>=2.1
+Requires-Dist: typer>=0.15
+Requires-Dist: uvicorn>=0.34
+Requires-Dist: websockets>=15
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+# Plural
+
+**Multiplayer sessions for one AI coding agent.**
+
+One agent. One host. Everyone in the room.
+
+[![Python](https://img.shields.io/badge/python-3.12%2B-3776AB?logo=python&logoColor=white)](https://www.python.org/downloads/)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/)
+[![Status](https://img.shields.io/badge/status-alpha-orange.svg)](#roadmap)
+
+[Quick start](#quick-start) · [How it works](#how-it-works) · [Security](#security-model) · [Architecture](#architecture) · [Contributing](#contributing)
+
+</div>
+
+---
+
+Plural turns a solo AI agent session into a shared one. The agent runs on the **host's machine** with the **host's API key**. Teammates join from a terminal or a browser, watch the run live, and propose prompts. The host stays in control: every proposal and every risky tool call goes through the host's approval.
+
+```text
+┌────────────┐        ┌──────────────┐        ┌─────────────┐
+│  guest TUI │◀──ws──▶│              │◀──ws──▶│  host       │
+├────────────┤        │  relay       │        │  ├ agent    │──▶ LLM API
+│  guest web │◀──ws──▶│  (optional,  │        │  ├ policy   │
+└────────────┘        │   dumb pipe) │        │  ├ tools    │──▶ workspace
+                      └──────────────┘        │  └ event log│
+                                              └─────────────┘
+```
+
+## Features
+
+- **Shared live session.** Everyone sees the same transcript, tool calls and diffs as they stream.
+- **Proposals, not prompts.** Guests suggest prompts. The host approves, edits or rejects them.
+- **Host-only approvals.** Write and exec actions need host consent. Guest-originated turns are tainted and always ask. Rejected actions are not re-asked: after repeated rejections of the same kind the agent is told to ask the user instead, and "Block (session)" denies a whole command class.
+- **Attribution.** Every turn records who wrote it and who approved it.
+- **Policy engine.** Allow, ask and deny rules with last-match-wins. Base deny rules cannot be overridden.
+- **Event-sourced.** An append-only SQLite log is the source of truth. Reconnect, replay and audit come for free.
+- **Isolation.** Tools are confined to the workspace. Secret paths are denied and output is redacted.
+- **Direct or relayed.** Connect over LAN directly, or through a relay that never sees permissions and never stores content.
+- **Terminal clients.** A Textual TUI and a plain line mode. A browser client is in progress.
+- **Bring your own key.** API keys only. Plural never touches subscription credentials.
+
+## Requirements
+
+- Python **3.12** or newer
+- [uv](https://docs.astral.sh/uv/) 0.5+
+- macOS or Linux (Windows through WSL)
+- Node.js 22+ (only to work on the in-progress web client)
+
+## Installation
+
+```sh
+curl -fsSL https://raw.githubusercontent.com/Plural-Organization/Plural/main/install.sh | sh
+```
+
+The script installs [uv](https://docs.astral.sh/uv/) if it is missing, then Plural. Or install it yourself:
+
+```sh
+uv tool install plural-agent
+```
+
+The package is `plural-agent`; it installs the `plural` command. Other ways:
+
+```sh
+pipx install plural-agent
+uvx --from plural-agent plural host
+```
+
+From source, clone the repository and run from its root:
+
+```sh
+uv sync
+```
+
+Check your environment:
+
+```sh
+plural doctor
+```
+
+## Quick start
+
+Start a session in your project:
+
+```sh
+uv run plural host --workspace .
+```
+
+The host prints a one-time invite link and opens the TUI. Send the link to a teammate:
+
+```sh
+uv run plural join "ws://127.0.0.1:7777/r_…?invite=…" --name alia
+```
+
+The default provider is `fake`, a scripted demo that needs no API key. Plain text lists the workspace. `$ cmd` asks to run `cmd` through `bash` and waits for host approval.
+
+### Through a relay
+
+```sh
+uv run plural relay --bind 0.0.0.0 --port 8787
+uv run plural host --relay wss://relay.example.com
+```
+
+A ready-made deployment with Caddy and TLS lives in [`deploy/`](deploy/).
+
+## Usage
+
+### Commands
+
+| Command | Purpose |
+|---|---|
+| `plural host` | Start a host session, direct mode or `--relay URL` |
+| `plural join <link>` | Join as a guest, `--plain` for a line-mode stream |
+| `plural relay` | Run the relay router |
+| `plural doctor` | Check the environment and workspace |
+| `plural export <room>` | Dump a session's event log to JSONL |
+
+Run `plural <command> --help` for all options.
+
+### TUI keys
+
+| Key | Action |
+|---|---|
+| `ctrl+r` | Review pending proposals and approvals |
+| `ctrl+o` | Create an invite link |
+| `ctrl+p` | View and edit session policy rules (host) |
+| `esc` | Abort the current run |
+| `ctrl+q` | Quit |
+
+Prompt-line commands work in the TUI and in `plural join --plain`: `/abort`, `/compact`, `/policy` (list rules), `/policy allow|ask|deny <tool> <pattern>`, `/policy rm <rule id>`.
+
+### Configuration
+
+Every setting can be passed as an environment variable with the `PLURAL_` prefix.
+
+| Variable | Default | Description |
+|---|---|---|
+| `PLURAL_PROVIDER` | `fake` | `fake`, `anthropic` or `openai` |
+| `PLURAL_MODEL` | `claude-opus-5-5` for `anthropic` | Model id, required for `openai` |
+| `PLURAL_API_KEY` | `ANTHROPIC_API_KEY` / `OPENAI_API_KEY` | Provider API key |
+| `PLURAL_BASE_URL` | provider default | Custom endpoint, e.g. a local OpenAI-compatible server |
+| `PLURAL_EFFORT` | provider default | `low`, `medium`, `high`, `xhigh` or `max` |
+| `PLURAL_MAX_OUTPUT_TOKENS` | provider default | Output token cap per model response |
+| `PLURAL_WORKSPACE` | current directory | Directory the agent works in |
+| `PLURAL_DATA_DIR` | `~/.plural` | Event logs, host key, attachments |
+| `PLURAL_BIND_HOST` | `127.0.0.1` | Bind address for direct mode |
+| `PLURAL_PORT` | `7777` | Port for direct mode |
+| `PLURAL_RELAY_URL` | none | Relay URL |
+| `PLURAL_PUBLIC_URL` | none | Public URL used in invite links |
+| `PLURAL_FIRST_TOKEN_TIMEOUT_S` | `120` | Seconds to wait for the model's first output before the run fails |
+| `PLURAL_IDLE_TIMEOUT_S` | `60` | Seconds of silence mid-response before the run fails |
+| `PLURAL_CONTEXT_WINDOW` | `128000` | Model context size in tokens; set it to the server's real window for local models |
+| `PLURAL_COMPACT_AT` | `0.75` | Fraction of the window at which the conversation is summarized |
+| `PLURAL_APPROVAL_TIMEOUT_S` | `120` | Seconds before an approval expires |
+| `PLURAL_REJECTION_LIMIT` | `2` | Rejections of one kind of action per run before the agent stops asking the host |
+| `PLURAL_TOKEN_TTL_S` | `86400` | Capability token lifetime, at most 24h |
+| `PLURAL_INVITE_TTL_S` | `3600` | Invite link lifetime |
+
+### Providers
+
+Two adapters cover most models: `anthropic` uses the official Anthropic SDK, and `openai` speaks the OpenAI Chat Completions format, which also covers OpenRouter, Groq, Gemini, DeepSeek and local servers such as Ollama.
+
+```sh
+PLURAL_PROVIDER=anthropic ANTHROPIC_API_KEY=sk-ant-... plural host
+
+PLURAL_PROVIDER=openai PLURAL_MODEL=gpt-5 OPENAI_API_KEY=sk-... plural host
+
+PLURAL_PROVIDER=openai PLURAL_MODEL=qwen2.5-coder PLURAL_BASE_URL=http://localhost:11434/v1 plural host
+```
+
+> [!NOTE]
+> Local servers truncate silently when a prompt exceeds their window (Ollama defaults to 4096 tokens). Start the server with a larger window (`OLLAMA_CONTEXT_LENGTH`) and set `PLURAL_CONTEXT_WINDOW` to the same value so compaction triggers in time.
+
+> [!IMPORTANT]
+> Plural uses API keys only. It never reads subscription logins or other credentials stored by vendor tools.
+
+## How it works
+
+1. The **host** starts a session. A `SessionActor` owns the room and processes every command in order: append to the log, reduce state, publish.
+2. A **guest** joins with an invite and receives a signed Ed25519 capability token bound to the room and connection.
+3. The guest **proposes** a prompt. The host approves it, and it enters the agent's queue attributed as `[alia, proposal approved by host]`.
+4. The **agent loop** streams the model's reply. Each tool call is prepared, evaluated by the `PolicyGate`, and either runs, waits for the host, or is denied.
+5. Every event goes to the **event log** first and is then fanned out to clients. A client that reconnects asks for events `since` its last `seq`.
+
+## Security model
+
+- The agent and the API key live only on the host. Guests never see the key.
+- Permission decisions are made only by the host. The relay is a dumb pipe.
+- No tool runs without passing the `PolicyGate`. There are no bypasses.
+- Tools are confined to the workspace with `realpath` checks and a deny-list for secret files such as `.env`, keys and credentials.
+- `bash` runs with a clean environment, in its own process group, with a timeout.
+- Secrets are redacted before anything is written to the log or sent to clients.
+
+See [`SECURITY.md`](SECURITY.md) to report a vulnerability and [`docs/threat-model.md`](docs/threat-model.md) for the full threat model.
+
+## Architecture
+
+Plural is a hexagonal, event-sourced Python app. Layers are enforced with `import-linter`.
+
+```text
+src/plural/
+├── protocol/   wire models, envelope, codec          (pure)
+├── core/       state reducer, roles, policy engine   (pure)
+├── security/   tokens, host keys, redaction
+├── agent/      harness: loop, tools, sandbox, providers
+├── storage/    SQLite event store, migrations, export
+├── host/       session actor, gateway, transports
+├── relay/      dumb relay router
+├── client/     connection, reconnect, projection
+├── cli/        Typer entry point
+└── tui/        Textual app
+web/            browser client (in progress)
+```
+
+- `core` and `protocol` do no I/O.
+- `agent` knows nothing about transports or storage.
+- `relay` knows nothing about sessions, policy or content.
+- `client` knows nothing about the host internals.
+
+Design notes: [`docs/adr/`](docs/adr/) · Wire protocol: [`docs/protocol.md`](docs/protocol.md)
+
+## Development
+
+```sh
+uv sync
+uv run pytest
+```
+
+Full check, the same one CI runs:
+
+```sh
+uv run ruff check . && uv run ruff format --check . && uv run pyright && uv run lint-imports && uv run pytest
+```
+
+Regenerate the protocol JSON schema for the web client:
+
+```sh
+uv run python scripts/gen_schema.py
+```
+
+Web client (in progress):
+
+```sh
+cd web
+npm ci
+npm run dev
+```
+
+## Roadmap
+
+- [x] Protocol, event log and session actor
+- [x] Policy engine and host approvals
+- [x] Workspace tools and local sandbox
+- [x] Direct and relay transports
+- [x] TUI and plain clients
+- [x] Anthropic and OpenAI-compatible providers
+- [ ] Web client (in progress)
+- [x] Context compaction
+- [ ] Container sandbox
+- [ ] End-to-end and load tests
+
+## Contributing
+
+Contributions are welcome. Read [`CONTRIBUTING.md`](CONTRIBUTING.md) first. In short:
+
+- Open an issue before large changes.
+- Use [Conventional Commits](https://www.conventionalcommits.org/).
+- New dependencies need discussion, and large ones need an ADR.
+- Make sure the full check passes.
+
+## Acknowledgements
+
+Plural learns from [Pi](https://github.com/badlogic/pi-mono), [OpenCode](https://github.com/sst/opencode) and [Hermes](https://github.com/NousResearch/hermes-agent).
+
+## License
+
+Plural is licensed under the [Apache License 2.0](LICENSE).