jupyterminal 0.0.1.dev0__tar.gz

jupyterminal-0.0.1.dev0/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

jupyterminal-0.0.1.dev0/PKG-INFO

@@ -0,0 +1,245 @@
+Metadata-Version: 2.4
+Name: jupyterminal
+Version: 0.0.1.dev0
+Summary: A terminal emulator whose session is a list of command blocks.
+Author: Asger Jon Vistisen
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/AsgerJon/jupyterminal
+Keywords: terminal,terminal-emulator,zsh,blocks
+Classifier: Environment :: X11 Applications :: Qt
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Terminals :: Terminal Emulators/X Terminals
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PySide6-Essentials>=6.8
+Dynamic: license-file
+
+[![Tokens](https://img.shields.io/badge/Tokens-297.5M-D97757)](https://claude.com/claude-code)
+[![codecov](https://codecov.io/gh/AsgerJon/jupyterminal/graph/badge.svg)](https://codecov.io/gh/AsgerJon/jupyterminal)
+[![PyPI version](https://img.shields.io/pypi/v/jupyterminal)](https://pypi.org/project/jupyterminal/)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+# jupyterminal v0.0.1-dev0 (development build)
+
+A terminal emulator in which typing and copying work the way they do
+everywhere else on the desktop.
+
+Commands are typed in a **text box**: a click places the cursor, Shift
+and the arrows select, typing replaces the selection, Ctrl+C, Ctrl+X and
+Ctrl+V are the clipboard and Ctrl+Z takes back. The session is a list of
+**blocks** instead of one continuous scroll. A block is one command plus
+everything it printed, kept as a unit you can select, copy and jump to.
+Copying a command's output takes one click and one shortcut — never a
+careful mouse drag.
+
+![jupyterminal](https://raw.githubusercontent.com/AsgerJon/jupyterminal/main/docs/screenshot.png)
+
+Built from `Block Terminal Cleanroom Functional Spec.pdf` and its
+addendum, `docs/cua-input.md`, alone. Linux, zsh, keyboard and mouse.
+
+## Install and run
+
+```sh
+conda env update -n jupyterminal_env -f environment.yml   # or: pip install -e .
+jupyterminal                                              # or: python -m jupyterminal
+```
+
+Needs Python ≥ 3.12, PySide6 and zsh. Options: `--shell PROGRAM`,
+`--login`, `-d DIR`, `--config FILE`, `--print-default-config`,
+`--install-desktop-entry`.
+
+`jupyterminal --install-desktop-entry` puts the program into the menus of
+your desktop, for you alone, started the way you started it just then.
+That entry is also what gives its windows their own icon in the task bar:
+on Wayland a desktop takes a window's icon from nowhere else.
+
+Python 3.11 is left out on purpose. PySide6 6.12.0 ends the interpreter
+there ("deallocating None") after a few thousand calls into Qt
+(PYSIDE-3474); from 3.12 on that kind of mistake in a binding can no
+longer do harm.
+
+## Using it
+
+The window is a list of blocks with a text box pinned underneath. Type a
+command into the box as into any text field and press Ctrl+Enter: zsh
+runs it, with your aliases and functions, and a block appears; its output
+streams into it; when the command ends the block records the exit code
+and duration. A failed command gets a red bar and a tinted background.
+
+In the text box:
+
+| Do this | To get this |
+| --- | --- |
+| Click, drag, double-click, triple-click | Place the cursor, select text, a word, a line |
+| Shift with the arrows, `Home`, `End` (and Ctrl for words) | Select |
+| `Ctrl+A` | Select everything in the box |
+| `Ctrl+C` `Ctrl+X` `Ctrl+V` | Copy, cut, paste |
+| `Ctrl+Z` `Ctrl+Y` | Take back, redo |
+| `Ctrl+Enter` | Run the command |
+| `Enter` | Start a new line: several lines run as one command |
+| `Tab` | Complete, the way Tab does in your zsh |
+| `Up` / `Down` on the first / last line | Your shell's history, the way those keys walk it in your zsh |
+| `Right` or `End`, at the end of the text | Take what zsh-autosuggestions suggests |
+| `Ctrl+Right`, at the end of the text | Take one word of it |
+| `Ctrl+D` on an empty box | End the session |
+
+`Ctrl+C` copies wherever something is selected, in the box or in the
+output. With nothing selected it interrupts the running command, or
+empties the box when none is running. Only one thing is selected at a
+time: selecting in the box lets go of what is selected in the output, and
+the other way round. A command that is not complete (a
+loop without its end) comes back into the box instead of being run. While
+a command runs, the keys go to that program.
+
+Completing and the history stay zsh's own work: the box hands it the
+text, zsh does what the key is bound to there, and the text comes back. A
+list of possible completions shows above the box; a completion menu, or a
+question zsh asks first, gets the keyboard until it is answered.
+
+If your zsh loads **zsh-syntax-highlighting** or **zsh-autosuggestions**,
+the box shows what they would show on zsh's own line: the text in the
+plugin's colors, and behind the cursor, dimmed, the line it suggests.
+
+To type in zsh's own line editor instead, as in other terminals, set
+`input = "shell"` under `[terminal]` in the configuration.
+
+Everywhere in the window:
+
+| Do this | To get this |
+| --- | --- |
+| Click a block | Select it (Ctrl+click adds or removes one, Shift+click takes a range) |
+| Click it again, click in the text box, press `Esc`, or just type | Let go of what is selected, blocks or text |
+| Click, with text selected | Let go of the text, and nothing else |
+| `Ctrl+Shift+C` | Copy: the selected text if there is any, otherwise the output of the selected blocks |
+| `Ctrl+Alt+Shift+C` | Copy `$ command` followed by the output |
+| Drag, double-click, triple-click | Select text, a word, a line (also fills the primary selection) |
+| `Ctrl+Shift+V`, `Shift+Ins`, middle click | Paste clipboard / primary selection |
+| `Ctrl+Up` | Select the newest block |
+| `Up` / `Down` | Move the selection (with Shift: extend it) |
+| `Ctrl+Shift+Up` / `Down` | Scroll to the top / bottom of the selected block |
+| Right-click, or the ⋮ button | Block menu: copy output / command / both, find, filter, collapse, re-run, save to file |
+| `Ctrl+Shift+F` / `Ctrl+Shift+L` | Find in block / filter output |
+| `Ctrl+L`, `clear` | Scroll blocks out of view (they stay reachable) |
+| `Ctrl+Shift+K` | Remove all blocks |
+| `Ctrl+=` `Ctrl+-` `Ctrl+0` | Font size |
+
+A command scrolled off the top stays pinned while its output is visible
+(click it to go to the block's start); a block taller than the window
+shows a jump-to-end button. Hovering a header shows when it started.
+
+### What copying gives you
+
+Plain text, exactly what the program printed: no colours or escape codes;
+a line the window wrapped is one line; trailing spaces and the final
+newline are dropped, tabs and blank lines are kept; a progress bar that
+redrew itself copies as its final state; several blocks are joined in
+order with one blank line between; with a filter active, only the lines
+shown.
+
+### Programs
+
+Inside a block the terminal is an ordinary xterm-compatible one: 24-bit
+colour, cursor movement, in-place progress bars, size queries. A REPL or a
+yes/no question lives in its block until it exits. Full-screen programs
+(vim, htop, less) take over the whole view; afterwards the block keeps its
+command, whatever was printed outside full-screen mode, and a
+"full-screen" marker.
+
+## Configuration
+
+`~/.config/jupyterminal/config.toml`; `jupyterminal --print-default-config`
+prints every key with its default. Font, shell, history cap
+(`scrollback_lines`, default 2,000,000 — the oldest blocks are dropped
+whole), colours, and every shortcut:
+
+```toml
+[keys]
+copy = "Ctrl+Y"
+[keys.blocks]            # while a block is selected
+previous = "K"
+next = "J"
+```
+
+A setting that cannot be used is reported on standard error when the
+program starts: the file, the setting, what it holds and what it may
+hold. The default stays in effect, and a misspelled colour is answered
+with the name that was probably meant.
+
+## How blocks are known
+
+Nothing is guessed from what output looks like. The terminal starts zsh
+with `ZDOTDIR` pointing at a private directory of shims that run your own
+startup files unchanged and then load a small integration script
+(`src/jupyterminal/shell/zsh/integration.zsh`). Its hooks emit private
+escape sequences when a command starts (with its exact text and
+directory) and ends (with its exit code), each carrying a per-session
+nonce so printed text cannot fake one. `ZDOTDIR` is restored and nothing
+of this stays in your environment. `exec zsh` (typed, aliased, or at the
+end of a compound line) re-integrates; a nested or remote shell is simply
+one long block.
+
+If your system sets `ZDOTDIR` in `/etc/zsh/zshenv`, zsh never reads the
+shims and the whole session shows up as one block. Add this line to your
+own `.zshrc` to load the integration directly:
+
+```zsh
+[[ -n $JUPYTERMINAL_DIR ]] && source $JUPYTERMINAL_DIR/integration.zsh
+```
+
+Output that arrives while no command runs — shell startup messages, a
+"job done" notice, a background job printing — goes into a
+"background output" block rather than onto your prompt.
+
+## Decisions made where the spec left room
+
+- **Header**: command in bold on a tinted strip; directory and git branch,
+  duration, exit code and controls right-aligned on the same line.
+- **Not run**: a line the shell rejects (a parse error) becomes a block
+  marked "not run" holding the shell's message, so the error is not lost.
+- **Save to file** writes the copy text plus a final newline.
+- **One endless block**: the cap drops whole blocks only, but a single
+  block larger than the entire cap has nothing older to drop, so its own
+  oldest lines go (the header says how many). Otherwise `yes` would eat
+  all memory.
+- **Background output at the prompt** goes to its own block only while
+  the line editor is provably idle: about half a second after your last
+  key, and with no other plugin registered that may redraw the line at
+  any time. A "job done" notice from zsh always gets its block.
+- **A pasted single line** loses its trailing newline, so pasting never
+  runs anything by itself; several lines ask first.
+- **`clear`** scrolls its own (empty) block out of view too.
+- Typing while a block is selected clears the selection.
+
+## Not there yet
+
+- Background output that arrives while it cannot be told apart from the
+  line editor's own drawing (you are typing, or an async prompt plugin is
+  active) lands on the prompt as in any terminal, and is not kept in a
+  block.
+- A function that calls `exec zsh` is not recognised; after it the
+  session is one block (type `exec zsh` itself, or use an alias).
+- Mouse reporting reaches programs in full-screen mode and at the prompt,
+  not ones drawing inside a block.
+- No hyperlinks (OSC 8), images, or extended keyboard protocols.
+- Other shells run, but without integration the session is one block.
+- The interface is tested through Qt's off-screen platform; see below.
+
+## Development
+
+```
+src/jupyterminal/term      terminal emulation: parser, screen model
+src/jupyterminal/shell     the pty and the zsh integration
+src/jupyterminal/session   blocks, the router that fills them, copy rules
+src/jupyterminal/ui        the Qt interface
+```
+
+`pytest` runs everything and measures the branch coverage: the emulator,
+the router, a real zsh under the session, the window driven off screen,
+and `tests/test_acceptance.py`, which has one test per acceptance
+criterion of the spec. `pytest -m "not live"` runs the tests that need no
+shell, in a few seconds.
+
+[CONTRIBUTING.md](CONTRIBUTING.md) has the rest: the 100% coverage rule,
+mutation testing before a release, and the nine buttons that publish one.

jupyterminal-0.0.1.dev0/README.md

@@ -0,0 +1,227 @@
+[![Tokens](https://img.shields.io/badge/Tokens-297.5M-D97757)](https://claude.com/claude-code)
+[![codecov](https://codecov.io/gh/AsgerJon/jupyterminal/graph/badge.svg)](https://codecov.io/gh/AsgerJon/jupyterminal)
+[![PyPI version](https://img.shields.io/pypi/v/jupyterminal)](https://pypi.org/project/jupyterminal/)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+# jupyterminal v0.0.1-dev0 (development build)
+
+A terminal emulator in which typing and copying work the way they do
+everywhere else on the desktop.
+
+Commands are typed in a **text box**: a click places the cursor, Shift
+and the arrows select, typing replaces the selection, Ctrl+C, Ctrl+X and
+Ctrl+V are the clipboard and Ctrl+Z takes back. The session is a list of
+**blocks** instead of one continuous scroll. A block is one command plus
+everything it printed, kept as a unit you can select, copy and jump to.
+Copying a command's output takes one click and one shortcut — never a
+careful mouse drag.
+
+![jupyterminal](https://raw.githubusercontent.com/AsgerJon/jupyterminal/main/docs/screenshot.png)
+
+Built from `Block Terminal Cleanroom Functional Spec.pdf` and its
+addendum, `docs/cua-input.md`, alone. Linux, zsh, keyboard and mouse.
+
+## Install and run
+
+```sh
+conda env update -n jupyterminal_env -f environment.yml   # or: pip install -e .
+jupyterminal                                              # or: python -m jupyterminal
+```
+
+Needs Python ≥ 3.12, PySide6 and zsh. Options: `--shell PROGRAM`,
+`--login`, `-d DIR`, `--config FILE`, `--print-default-config`,
+`--install-desktop-entry`.
+
+`jupyterminal --install-desktop-entry` puts the program into the menus of
+your desktop, for you alone, started the way you started it just then.
+That entry is also what gives its windows their own icon in the task bar:
+on Wayland a desktop takes a window's icon from nowhere else.
+
+Python 3.11 is left out on purpose. PySide6 6.12.0 ends the interpreter
+there ("deallocating None") after a few thousand calls into Qt
+(PYSIDE-3474); from 3.12 on that kind of mistake in a binding can no
+longer do harm.
+
+## Using it
+
+The window is a list of blocks with a text box pinned underneath. Type a
+command into the box as into any text field and press Ctrl+Enter: zsh
+runs it, with your aliases and functions, and a block appears; its output
+streams into it; when the command ends the block records the exit code
+and duration. A failed command gets a red bar and a tinted background.
+
+In the text box:
+
+| Do this | To get this |
+| --- | --- |
+| Click, drag, double-click, triple-click | Place the cursor, select text, a word, a line |
+| Shift with the arrows, `Home`, `End` (and Ctrl for words) | Select |
+| `Ctrl+A` | Select everything in the box |
+| `Ctrl+C` `Ctrl+X` `Ctrl+V` | Copy, cut, paste |
+| `Ctrl+Z` `Ctrl+Y` | Take back, redo |
+| `Ctrl+Enter` | Run the command |
+| `Enter` | Start a new line: several lines run as one command |
+| `Tab` | Complete, the way Tab does in your zsh |
+| `Up` / `Down` on the first / last line | Your shell's history, the way those keys walk it in your zsh |
+| `Right` or `End`, at the end of the text | Take what zsh-autosuggestions suggests |
+| `Ctrl+Right`, at the end of the text | Take one word of it |
+| `Ctrl+D` on an empty box | End the session |
+
+`Ctrl+C` copies wherever something is selected, in the box or in the
+output. With nothing selected it interrupts the running command, or
+empties the box when none is running. Only one thing is selected at a
+time: selecting in the box lets go of what is selected in the output, and
+the other way round. A command that is not complete (a
+loop without its end) comes back into the box instead of being run. While
+a command runs, the keys go to that program.
+
+Completing and the history stay zsh's own work: the box hands it the
+text, zsh does what the key is bound to there, and the text comes back. A
+list of possible completions shows above the box; a completion menu, or a
+question zsh asks first, gets the keyboard until it is answered.
+
+If your zsh loads **zsh-syntax-highlighting** or **zsh-autosuggestions**,
+the box shows what they would show on zsh's own line: the text in the
+plugin's colors, and behind the cursor, dimmed, the line it suggests.
+
+To type in zsh's own line editor instead, as in other terminals, set
+`input = "shell"` under `[terminal]` in the configuration.
+
+Everywhere in the window:
+
+| Do this | To get this |
+| --- | --- |
+| Click a block | Select it (Ctrl+click adds or removes one, Shift+click takes a range) |
+| Click it again, click in the text box, press `Esc`, or just type | Let go of what is selected, blocks or text |
+| Click, with text selected | Let go of the text, and nothing else |
+| `Ctrl+Shift+C` | Copy: the selected text if there is any, otherwise the output of the selected blocks |
+| `Ctrl+Alt+Shift+C` | Copy `$ command` followed by the output |
+| Drag, double-click, triple-click | Select text, a word, a line (also fills the primary selection) |
+| `Ctrl+Shift+V`, `Shift+Ins`, middle click | Paste clipboard / primary selection |
+| `Ctrl+Up` | Select the newest block |
+| `Up` / `Down` | Move the selection (with Shift: extend it) |
+| `Ctrl+Shift+Up` / `Down` | Scroll to the top / bottom of the selected block |
+| Right-click, or the ⋮ button | Block menu: copy output / command / both, find, filter, collapse, re-run, save to file |
+| `Ctrl+Shift+F` / `Ctrl+Shift+L` | Find in block / filter output |
+| `Ctrl+L`, `clear` | Scroll blocks out of view (they stay reachable) |
+| `Ctrl+Shift+K` | Remove all blocks |
+| `Ctrl+=` `Ctrl+-` `Ctrl+0` | Font size |
+
+A command scrolled off the top stays pinned while its output is visible
+(click it to go to the block's start); a block taller than the window
+shows a jump-to-end button. Hovering a header shows when it started.
+
+### What copying gives you
+
+Plain text, exactly what the program printed: no colours or escape codes;
+a line the window wrapped is one line; trailing spaces and the final
+newline are dropped, tabs and blank lines are kept; a progress bar that
+redrew itself copies as its final state; several blocks are joined in
+order with one blank line between; with a filter active, only the lines
+shown.
+
+### Programs
+
+Inside a block the terminal is an ordinary xterm-compatible one: 24-bit
+colour, cursor movement, in-place progress bars, size queries. A REPL or a
+yes/no question lives in its block until it exits. Full-screen programs
+(vim, htop, less) take over the whole view; afterwards the block keeps its
+command, whatever was printed outside full-screen mode, and a
+"full-screen" marker.
+
+## Configuration
+
+`~/.config/jupyterminal/config.toml`; `jupyterminal --print-default-config`
+prints every key with its default. Font, shell, history cap
+(`scrollback_lines`, default 2,000,000 — the oldest blocks are dropped
+whole), colours, and every shortcut:
+
+```toml
+[keys]
+copy = "Ctrl+Y"
+[keys.blocks]            # while a block is selected
+previous = "K"
+next = "J"
+```
+
+A setting that cannot be used is reported on standard error when the
+program starts: the file, the setting, what it holds and what it may
+hold. The default stays in effect, and a misspelled colour is answered
+with the name that was probably meant.
+
+## How blocks are known
+
+Nothing is guessed from what output looks like. The terminal starts zsh
+with `ZDOTDIR` pointing at a private directory of shims that run your own
+startup files unchanged and then load a small integration script
+(`src/jupyterminal/shell/zsh/integration.zsh`). Its hooks emit private
+escape sequences when a command starts (with its exact text and
+directory) and ends (with its exit code), each carrying a per-session
+nonce so printed text cannot fake one. `ZDOTDIR` is restored and nothing
+of this stays in your environment. `exec zsh` (typed, aliased, or at the
+end of a compound line) re-integrates; a nested or remote shell is simply
+one long block.
+
+If your system sets `ZDOTDIR` in `/etc/zsh/zshenv`, zsh never reads the
+shims and the whole session shows up as one block. Add this line to your
+own `.zshrc` to load the integration directly:
+
+```zsh
+[[ -n $JUPYTERMINAL_DIR ]] && source $JUPYTERMINAL_DIR/integration.zsh
+```
+
+Output that arrives while no command runs — shell startup messages, a
+"job done" notice, a background job printing — goes into a
+"background output" block rather than onto your prompt.
+
+## Decisions made where the spec left room
+
+- **Header**: command in bold on a tinted strip; directory and git branch,
+  duration, exit code and controls right-aligned on the same line.
+- **Not run**: a line the shell rejects (a parse error) becomes a block
+  marked "not run" holding the shell's message, so the error is not lost.
+- **Save to file** writes the copy text plus a final newline.
+- **One endless block**: the cap drops whole blocks only, but a single
+  block larger than the entire cap has nothing older to drop, so its own
+  oldest lines go (the header says how many). Otherwise `yes` would eat
+  all memory.
+- **Background output at the prompt** goes to its own block only while
+  the line editor is provably idle: about half a second after your last
+  key, and with no other plugin registered that may redraw the line at
+  any time. A "job done" notice from zsh always gets its block.
+- **A pasted single line** loses its trailing newline, so pasting never
+  runs anything by itself; several lines ask first.
+- **`clear`** scrolls its own (empty) block out of view too.
+- Typing while a block is selected clears the selection.
+
+## Not there yet
+
+- Background output that arrives while it cannot be told apart from the
+  line editor's own drawing (you are typing, or an async prompt plugin is
+  active) lands on the prompt as in any terminal, and is not kept in a
+  block.
+- A function that calls `exec zsh` is not recognised; after it the
+  session is one block (type `exec zsh` itself, or use an alias).
+- Mouse reporting reaches programs in full-screen mode and at the prompt,
+  not ones drawing inside a block.
+- No hyperlinks (OSC 8), images, or extended keyboard protocols.
+- Other shells run, but without integration the session is one block.
+- The interface is tested through Qt's off-screen platform; see below.
+
+## Development
+
+```
+src/jupyterminal/term      terminal emulation: parser, screen model
+src/jupyterminal/shell     the pty and the zsh integration
+src/jupyterminal/session   blocks, the router that fills them, copy rules
+src/jupyterminal/ui        the Qt interface
+```
+
+`pytest` runs everything and measures the branch coverage: the emulator,
+the router, a real zsh under the session, the window driven off screen,
+and `tests/test_acceptance.py`, which has one test per acceptance
+criterion of the spec. `pytest -m "not live"` runs the tests that need no
+shell, in a few seconds.
+
+[CONTRIBUTING.md](CONTRIBUTING.md) has the rest: the 100% coverage rule,
+mutation testing before a release, and the nine buttons that publish one.