prismal-tui 0.2.0__tar.gz

prismal_tui-0.2.0/.gitignore

@@ -0,0 +1,219 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+.idea/

prismal_tui-0.2.0/CHANGELOG.md

@@ -0,0 +1,87 @@
+# Changelog
+
+All notable changes to `prismal-tui`. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the project uses
+[Semantic Versioning](https://semver.org/).
+
+## [0.2.0] — 2026-11-03
+
+Targets `prismal-server` 0.3 and `prismal-sdk` 0.3
+(`DELTA-2026-11-host-0.3`).
+
+### Changed
+
+- **The SDK now comes from PyPI.** The dependency is `prismal-ai-sdk>=0.3,<1`
+  (the SDK's PyPI distribution name; the import module is still
+  `prismal_sdk`). A `../prismal-sdk` checkout is no longer needed. This
+  also fixes `uv sync`, which failed once the SDK renamed its project.
+- **Published on PyPI** as `prismal-tui`: `uvx prismal-tui` or
+  `pipx install prismal-tui` (`TUI-FUTURE-01`). Releases publish from `main`
+  through PyPI trusted publishing, then tag `v<version>` and create the
+  GitHub release. They no longer run on tag pushes.
+- CI's contract job installs `prismal-server` 0.3.x from PyPI into its own
+  virtualenv, starts it in fake-LLM mode with AG-UI on, and runs on every
+  pull request.
+
+### Added
+
+- **Agent questions and `/resume`.** With `PRISMAL_TUI_PROTOCOL=ag-ui`
+  (default `prismal`, unchanged), turns stream over AG-UI. When the agent
+  pauses at an approval gate, the transcript shows its question and
+  `/resume <answer>` answers it. Valid JSON is sent as the decoded value
+  (e.g. `/resume {"action": "approve"}`); anything else is sent as the
+  text. Answers are never mapped to actions or re-sent automatically. Open
+  questions stay in memory only.
+- Friendly copy for the new refusals: AG-UI disabled on the host, an answer
+  that was already consumed or is still running, and an answer the server
+  rejected.
+
+## [0.1.1] — 2026-11-02
+
+### Added
+
+- **Slash escape.** `//text` sends the message `/text`, so a message can
+  start with `/` (for example `//etc/hosts doesn't resolve`). Exactly one
+  slash is removed and the rest is sent unmodified. A single leading `/`
+  is still a command. Listed in `/help` (`DELTA-2026-11-slash-escape`).
+
+## [0.1.0] — 2026-11-02
+
+First release. A Textual terminal front-end for `prismal-server`, built only
+on `prismal-sdk` (`>=0.2,<1`). It installs from source: `prismal-sdk` 0.2 is
+not on PyPI yet, so check out `../prismal-sdk` next to this repo. PyPI is
+`TUI-FUTURE-01`.
+
+### Added
+
+- **Chat.** Streamed answers rendered with frame-based coalescing and
+  re-rendered as Markdown when the turn ends. Tool calls show as `⚙` lines.
+  User text reaches the engine unmodified.
+- **Conversations.** A sidebar plus `/new`, `/switch`, `/rename` and
+  `/delete` for named local conversations. Each maps to one durable engine
+  thread in a local SQLite store, which holds no messages and no secrets.
+  The mapping is persisted before the first message is sent.
+- **Cancel.** `Esc` (or `PRISMAL_TUI_CANCEL_KEY`) and `/cancel` close the
+  stream, and the host cancels the run. Partial text is always kept.
+- **Errors.** Friendly copy in the transcript, the status bar and a toast.
+  No error codes, server messages or tracebacks are shown, and nothing is
+  retried automatically.
+- **Usage (DELTA-2026-10).** A status-bar readout of the last turn and the
+  session (tokens, cache %, cost labels `~`, `(plan)`, `$?` and `*`).
+  `/usage` and `/usage all` open a modal fed by the server's
+  `GET /v1/usage`. A budget stop reads "Budget limit reached on the server —
+  run /usage for details".
+- **Polish.** Status bar with connection state and key hints, help on `F1`
+  and `/help`, and a background health check that never blocks startup.
+- **Configuration.** `PRISMAL_TUI_*` environment variables only, validated
+  at startup without echoing values (see `docs/configuration.md`). The token
+  is a `SecretStr` that never reaches the screen, the store or the log. The
+  log file is mode `0600` and holds no message text.
+- **Quality.** Offline unit and Pilot UI suites with a coverage floor of
+  97%, an AST boundary guard, an end-to-end secret-leak test and a
+  responsiveness probe. An opt-in `contract` suite runs against a live
+  `prismal-server` 0.2, which CI can start in fake-LLM mode.
+
+[0.2.0]: https://github.com/prismal-ai/prismal-tui/releases/tag/v0.2.0
+[0.1.1]: https://github.com/prismal-ai/prismal-tui/releases/tag/v0.1.1
+[0.1.0]: https://github.com/prismal-ai/prismal-tui/releases/tag/v0.1.0

prismal_tui-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 prismal-ai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

prismal_tui-0.2.0/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.5
+Name: prismal-tui
+Version: 0.2.0
+Summary: Terminal UI (Textual) for prismal-server, built exclusively on prismal-sdk (PyPI: prismal-ai-sdk).
+Project-URL: Repository, https://github.com/prismal-ai/prismal-tui
+Project-URL: Changelog, https://github.com/prismal-ai/prismal-tui/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://github.com/prismal-ai/prismal-tui/blob/main/docs/configuration.md
+Project-URL: SDK, https://github.com/prismal-ai/prismal-sdk
+Project-URL: Server, https://github.com/prismal-ai/prismal-server
+Author-email: Ernesto Crespo <ecrespo@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 prismal-ai
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: chat,prismal,terminal,textual,tui
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Requires-Dist: platformdirs<4.15,>=4.14
+Requires-Dist: prismal-ai-sdk<1,>=0.3
+Requires-Dist: pydantic-settings<3,>=2.5
+Requires-Dist: textual<8.3,>=8.2
+Provides-Extra: dev
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest-timeout>=2.3; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# prismal-tui
+
+Terminal UI for the [prismal](https://github.com/prismal-ai/prismal)
+ecosystem — an interactive [Textual](https://textual.textualize.io/)
+application you run locally to talk to a running
+[`prismal-server`](https://github.com/prismal-ai/prismal-server),
+exclusively through [`prismal-sdk`](https://github.com/prismal-ai/prismal-sdk)
+(`AsyncPrismalClient`).
+
+There is no browser and no chat platform here: keystrokes go straight into
+a `ConversationSession` that resolves or creates one engine `thread_id` per
+locally-named conversation, persists that mapping in a local SQLite
+`ConversationStore` (so restarting the app never forks an ongoing
+conversation), streams the reply through `prismal-sdk`, and renders it as
+Markdown in a scrollable transcript — with a single key press (`Esc` by
+default) to cancel mid-turn.
+
+> **Status: `0.1.1`** — all of `tui-bootstrap` (phases TUI-00…04 and the
+> usage readout, `DELTA-2026-10`) is implemented; see
+> [`CHANGELOG.md`](./CHANGELOG.md) and
+> [`specs/tui-bootstrap/TASKS.md`](./specs/tui-bootstrap/TASKS.md). Installs
+> from source (not on PyPI yet).
+
+## Ecosystem position
+
+```
+developer's terminal ── keyboard/ANSI ──▶ prismal-tui (this repo)
+                                               │  prismal_sdk (HTTP + SSE)
+                                               ▼
+                                          prismal-server ──▶ prismal (engine)
+```
+
+| Repo | Role | Status |
+|---|---|---|
+| [`prismal`](https://github.com/prismal-ai/prismal) | Engine (LangGraph supervisor, 29 routes, RAG, security) | v3.22.1 (PyPI `prismal-ai`) |
+| [`prismal-server`](https://github.com/prismal-ai/prismal-server) | FastAPI host (REST + SSE + AG-UI + A2A) | v0.3.0 (PyPI) |
+| [`prismal-sdk`](https://github.com/prismal-ai/prismal-sdk) | Typed Python client (sync + async) | v0.3.0 (PyPI `prismal-ai-sdk`) |
+| [`prismal-webchat`](https://github.com/prismal-ai/prismal-webchat) | Embeddable browser chat widget | SDD seed |
+| [`prismal-chatbot`](https://github.com/prismal-ai/prismal-chatbot) | External bots — Slack, Discord | SDD seed |
+| `prismal-tui` | Terminal UI (this repo) | **pre-release** |
+
+## What v0.1 delivers
+
+A single-process Textual app: a scrollable, Markdown-rendered transcript
+that streams tokens as the engine produces them, visible tool-call
+activity, a sidebar to create/switch/rename/delete named local
+conversations (each backed by its own durable engine thread), a small
+slash-command set (`/new`, `/switch`, `/rename`, `/delete`, `/usage`,
+`/cancel`, `/quit`, `/help`), immediate keyboard cancellation of an
+in-flight turn, a status-bar token/cost readout per turn and per session
+(from `prismal-server` ≥ 0.2's own usage numbers), and friendly error
+messages on failure. See `specs/tui-bootstrap/PLAN.md`
+§5 for the full in/out-of-scope list.
+
+## Install
+
+```bash
+uvx prismal-tui                 # run without installing
+# or: pipx install prismal-tui / uv tool install prismal-tui
+```
+
+Point it at your server with `PRISMAL_TUI_SERVER_URL` (and `PRISMAL_TUI_TOKEN`
+if it needs one); every setting is in
+[`docs/configuration.md`](./docs/configuration.md).
+
+## Quickstart (dev)
+
+Requires Python 3.13, [`uv`](https://docs.astral.sh/uv/) and a running
+`prismal-server` (defaults to `http://localhost:8000`). The SDK comes from
+PyPI as [`prismal-ai-sdk`](https://pypi.org/project/prismal-ai-sdk/)
+(import module `prismal_sdk`); no sibling checkout is needed.
+
+```bash
+uv sync --extra dev
+
+export PRISMAL_TUI_SERVER_URL="http://localhost:8000"
+export PRISMAL_TUI_TOKEN="…"           # service credential, optional locally
+
+prismal-tui
+# or: python -m prismal_tui
+```
+
+Inside the app: type a message and press Enter to send, `Esc` to cancel a
+streaming reply, `/new <name>` to start a new conversation, `/help` for the
+full key-binding and command list. With `PRISMAL_TUI_PROTOCOL=ag-ui` (host
+with AG-UI enabled) the agent's approval questions show up in the transcript
+and `/resume <answer>` answers them — see
+[`docs/configuration.md`](./docs/configuration.md).
+
+## Configuration
+
+| Env var | Default | Meaning |
+|---|---|---|
+| `PRISMAL_TUI_SERVER_URL` | `http://localhost:8000` | Target `prismal-server` |
+| `PRISMAL_TUI_TOKEN` | — | Bearer credential (never rendered or persisted) |
+| `PRISMAL_TUI_ORG_ID` | — | Tenant for all TUI traffic (`X-Org-Id`) |
+| `PRISMAL_TUI_STORE_PATH` | `platformdirs` user-data dir | Local `ConversationStore` SQLite file |
+| `PRISMAL_TUI_CANCEL_KEY` | `escape` | Key binding that cancels an in-flight turn |
+| `PRISMAL_TUI_LOG_LEVEL` | `INFO` | Local log file verbosity |
+
+Full reference: [`docs/configuration.md`](./docs/configuration.md).
+
+## Development
+
+```bash
+uv run pytest                       # unit + ui suite — offline, fake SDK client + Textual Pilot
+uv run pytest -m contract           # opt-in — against a running prismal-server
+                                    # (PRISMAL_TUI_SERVER_URL; fake-LLM mode recommended)
+uv run ruff check . && uv run mypy prismal_tui
+```
+
+Boundary rules (no `prismal`/`prismal_server` imports, no direct HTTP to
+the host, no secret ever rendered, logged, or persisted) are enforced by
+tests — see [`CLAUDE.md`](./CLAUDE.md) for the review checklist. Before a
+release, run [`docs/manual-verification.md`](./docs/manual-verification.md)
+against a real host.
+
+## License
+
+[MIT](./LICENSE)

prismal_tui-0.2.0/README.md

@@ -0,0 +1,120 @@
+# prismal-tui
+
+Terminal UI for the [prismal](https://github.com/prismal-ai/prismal)
+ecosystem — an interactive [Textual](https://textual.textualize.io/)
+application you run locally to talk to a running
+[`prismal-server`](https://github.com/prismal-ai/prismal-server),
+exclusively through [`prismal-sdk`](https://github.com/prismal-ai/prismal-sdk)
+(`AsyncPrismalClient`).
+
+There is no browser and no chat platform here: keystrokes go straight into
+a `ConversationSession` that resolves or creates one engine `thread_id` per
+locally-named conversation, persists that mapping in a local SQLite
+`ConversationStore` (so restarting the app never forks an ongoing
+conversation), streams the reply through `prismal-sdk`, and renders it as
+Markdown in a scrollable transcript — with a single key press (`Esc` by
+default) to cancel mid-turn.
+
+> **Status: `0.1.1`** — all of `tui-bootstrap` (phases TUI-00…04 and the
+> usage readout, `DELTA-2026-10`) is implemented; see
+> [`CHANGELOG.md`](./CHANGELOG.md) and
+> [`specs/tui-bootstrap/TASKS.md`](./specs/tui-bootstrap/TASKS.md). Installs
+> from source (not on PyPI yet).
+
+## Ecosystem position
+
+```
+developer's terminal ── keyboard/ANSI ──▶ prismal-tui (this repo)
+                                               │  prismal_sdk (HTTP + SSE)
+                                               ▼
+                                          prismal-server ──▶ prismal (engine)
+```
+
+| Repo | Role | Status |
+|---|---|---|
+| [`prismal`](https://github.com/prismal-ai/prismal) | Engine (LangGraph supervisor, 29 routes, RAG, security) | v3.22.1 (PyPI `prismal-ai`) |
+| [`prismal-server`](https://github.com/prismal-ai/prismal-server) | FastAPI host (REST + SSE + AG-UI + A2A) | v0.3.0 (PyPI) |
+| [`prismal-sdk`](https://github.com/prismal-ai/prismal-sdk) | Typed Python client (sync + async) | v0.3.0 (PyPI `prismal-ai-sdk`) |
+| [`prismal-webchat`](https://github.com/prismal-ai/prismal-webchat) | Embeddable browser chat widget | SDD seed |
+| [`prismal-chatbot`](https://github.com/prismal-ai/prismal-chatbot) | External bots — Slack, Discord | SDD seed |
+| `prismal-tui` | Terminal UI (this repo) | **pre-release** |
+
+## What v0.1 delivers
+
+A single-process Textual app: a scrollable, Markdown-rendered transcript
+that streams tokens as the engine produces them, visible tool-call
+activity, a sidebar to create/switch/rename/delete named local
+conversations (each backed by its own durable engine thread), a small
+slash-command set (`/new`, `/switch`, `/rename`, `/delete`, `/usage`,
+`/cancel`, `/quit`, `/help`), immediate keyboard cancellation of an
+in-flight turn, a status-bar token/cost readout per turn and per session
+(from `prismal-server` ≥ 0.2's own usage numbers), and friendly error
+messages on failure. See `specs/tui-bootstrap/PLAN.md`
+§5 for the full in/out-of-scope list.
+
+## Install
+
+```bash
+uvx prismal-tui                 # run without installing
+# or: pipx install prismal-tui / uv tool install prismal-tui
+```
+
+Point it at your server with `PRISMAL_TUI_SERVER_URL` (and `PRISMAL_TUI_TOKEN`
+if it needs one); every setting is in
+[`docs/configuration.md`](./docs/configuration.md).
+
+## Quickstart (dev)
+
+Requires Python 3.13, [`uv`](https://docs.astral.sh/uv/) and a running
+`prismal-server` (defaults to `http://localhost:8000`). The SDK comes from
+PyPI as [`prismal-ai-sdk`](https://pypi.org/project/prismal-ai-sdk/)
+(import module `prismal_sdk`); no sibling checkout is needed.
+
+```bash
+uv sync --extra dev
+
+export PRISMAL_TUI_SERVER_URL="http://localhost:8000"
+export PRISMAL_TUI_TOKEN="…"           # service credential, optional locally
+
+prismal-tui
+# or: python -m prismal_tui
+```
+
+Inside the app: type a message and press Enter to send, `Esc` to cancel a
+streaming reply, `/new <name>` to start a new conversation, `/help` for the
+full key-binding and command list. With `PRISMAL_TUI_PROTOCOL=ag-ui` (host
+with AG-UI enabled) the agent's approval questions show up in the transcript
+and `/resume <answer>` answers them — see
+[`docs/configuration.md`](./docs/configuration.md).
+
+## Configuration
+
+| Env var | Default | Meaning |
+|---|---|---|
+| `PRISMAL_TUI_SERVER_URL` | `http://localhost:8000` | Target `prismal-server` |
+| `PRISMAL_TUI_TOKEN` | — | Bearer credential (never rendered or persisted) |
+| `PRISMAL_TUI_ORG_ID` | — | Tenant for all TUI traffic (`X-Org-Id`) |
+| `PRISMAL_TUI_STORE_PATH` | `platformdirs` user-data dir | Local `ConversationStore` SQLite file |
+| `PRISMAL_TUI_CANCEL_KEY` | `escape` | Key binding that cancels an in-flight turn |
+| `PRISMAL_TUI_LOG_LEVEL` | `INFO` | Local log file verbosity |
+
+Full reference: [`docs/configuration.md`](./docs/configuration.md).
+
+## Development
+
+```bash
+uv run pytest                       # unit + ui suite — offline, fake SDK client + Textual Pilot
+uv run pytest -m contract           # opt-in — against a running prismal-server
+                                    # (PRISMAL_TUI_SERVER_URL; fake-LLM mode recommended)
+uv run ruff check . && uv run mypy prismal_tui
+```
+
+Boundary rules (no `prismal`/`prismal_server` imports, no direct HTTP to
+the host, no secret ever rendered, logged, or persisted) are enforced by
+tests — see [`CLAUDE.md`](./CLAUDE.md) for the review checklist. Before a
+release, run [`docs/manual-verification.md`](./docs/manual-verification.md)
+against a real host.
+
+## License
+
+[MIT](./LICENSE)