letee 0.1.22__tar.gz

letee-0.1.22/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.

letee-0.1.22/PKG-INFO

@@ -0,0 +1,262 @@
+Metadata-Version: 2.4
+Name: letee
+Version: 0.1.22
+Summary: Outer tmux cockpit for local and SSH tmux sessions
+Author: Julien Semaan
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/julsemaan/letee
+Project-URL: Repository, https://github.com/julsemaan/letee
+Project-URL: Issues, https://github.com/julsemaan/letee/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console :: Curses
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Terminals :: Terminal Emulators/X Terminals
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: coverage[toml]; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+<p align="center">
+  <img src="logo.png" alt="letee logo" width="280">
+</p>
+
+<h1 align="center">letee</h1>
+
+<p align="center">
+  Letee, pronounced luh-tee.<br>
+  Every tmux session, local or remote, at your fingertips.
+</p>
+
+`letee` runs inside your existing terminal and works on top of tmux. No new terminal app, no replacement tmux setup, no retraining your keyboard muscle memory. Keep your terminal, tmux configuration, keybindings, plugins, and workflows while adding a persistent sidebar for finding, opening, and switching between sessions across your machine and SSH hosts. Your sessions remain ordinary tmux sessions; letee simply puts them within reach.
+
+Track important sessions, see at a glance which ones need attention, and jump between local and remote work without hunting through terminal tabs.
+
+## Why letee?
+
+- **Keep your terminal and tmux setup**: unlike cmux, letee runs inside your current terminal and builds on tmux instead of forcing a new terminal app. Your configuration, keybindings, plugins, and workflows keep working.
+- **One view across machines**: local and remote sessions live in the same sidebar.
+- **Fast context switches**: see which sessions need your attention via tmux bells, then jump straight to them.
+
+## Quick start
+
+Requires Python 3.11+, tmux, and OpenSSH. Automatic coding-agent discovery additionally requires [astatus](https://github.com/julsemaan/astatus) locally and on configured remote hosts.
+
+```sh
+pip install letee
+letee
+```
+
+That opens an outer tmux workspace with the letee sidebar on the left and your selected session on the right. Press `Enter` on a session to step into it; press `q` to close the sidebar, then `C-s s` to reopen it on Sessions.
+
+## How it works
+
+`letee` creates or attaches to a dedicated outer tmux server. That outer layer owns only the layout:
+
+- outer prefix: `C-s`
+- focus/open Sessions: `C-s s`
+- add session: `C-s +`
+- focus/open Agents: `C-s a`
+- hide sidebar: `C-s h`
+- quit cockpit: `C-s q`
+- show help: `C-s ?`
+- detach cockpit: `C-s d`
+- forward outer prefix to inner session: `C-s C-s`
+- standard outer tmux prefix bindings: disabled
+- outer status: off
+- left pane: `letee` sidebar, 40 columns by default
+- right pane: selected local/remote tmux attach client
+
+Inner local and remote sessions keep their normal tmux prefix and bindings, and remain alive when you switch away. Only letee's outer `prefix` key table is restricted.
+
+## Configuration
+
+Files live in `~/.config/letee/`:
+
+```toml
+hosts = ["my-remote-machine"]
+prefix = "C-s"
+sidebar_width = 40
+status_timeout = 5
+persistent_ssh = true
+```
+
+### Prefix
+
+`prefix` accepts one non-empty, printable tmux key token without whitespace. `sidebar_width` sets left pane width in columns. `status_timeout` controls how many seconds sidebar feedback remains visible. Both numeric settings must be positive integers. Restart sidebar by rerunning `letee` after changing these values.
+
+`C-s` normally sends XOFF when terminal `IXON` flow control is enabled. Attached tmux disables flow control on outer tty, so outer prefix works without global `stty` changes. Readline, Emacs, or Vim `C-s` commands require `C-s C-s` to forward literal `C-s`; inner tty may still treat it as XOFF, in which case `C-q` resumes output.
+
+To restore old prefix, set `prefix = "C-g"` and rerun `letee`.
+
+### Remote hosts
+
+Hosts are SSH aliases only. Keep host-specific users, ports, keys, proxies, IPv6, and other connection settings in `~/.ssh/config`.
+
+By default, letee makes OpenSSH reuse one authenticated transport per host with `ControlMaster=auto`, `ControlPersist=10m`, and `ControlPath=~/.ssh/letee-%C`. Later discovery polls, switches, creates, and kills avoid repeating TCP setup, key exchange, and authentication. Control sockets remain for 10 minutes after last use.
+
+Every letee SSH connection also uses `ServerAliveInterval=60` and `ServerAliveCountMax=3` to detect dead connections and keep idle sessions active through network and NAT timeouts. Keepalive remains enabled when `persistent_ssh` is disabled.
+
+To omit letee's persistence options, set:
+
+```toml
+persistent_ssh = false
+```
+
+SSH config still applies, so this opt-out does not disable multiplexing configured there.
+
+Names of the hosts must match:
+
+```text
+[A-Za-z0-9_.-]{1,64}
+```
+
+## CLI commands
+
+```sh
+letee list
+letee switch local:<session>
+letee switch ssh:<host>:<session>
+letee switch-session <1-9>
+letee create local <session>
+letee create ssh <host> <session>
+letee kill local:<session>
+letee kill ssh:<host>:<session>
+```
+
+Switching uses outer tmux `respawn-pane` on right pane. Real tmux sessions stay alive.
+
+## Sidebar keys
+
+- `C-s s`: focus Sessions; recreates sidebar if quit
+- `C-s +`: focus Sessions and open Add session menu
+- `C-s a`: focus Agents; recreates sidebar if quit
+- `C-s h`: hide sidebar
+- `C-s q`: quit outer letee
+- `C-s ?`: show help in right pane
+- `C-s d`: detach outer letee
+- `C-s C-s`: forward `C-s` to inner session
+- `C-s 1`–`C-s 9`: switch directly to numbered tracked target
+- `j` / `k` or arrows: move selection pointer (`›`) in focused region
+- `[` / `]`: give Agents/Sessions region more rows for current run
+- `h` / `l`: cycle agent ordering mode (Priority / Session) when ordering row is selected
+- `Enter`: switch selected session or exact agent pane, or activate selected Add row
+- `a`: open Add session menu from Sessions or Agents
+- `r`: remove selected target without killing it
+- `K` / `J`: move selected tracked target up/down without wrapping
+- `x`: kill and remove selected tracked session (asks first)
+- `/`: open existing-session search directly
+- `?`: open help in right pane
+- `q`: quit sidebar only
+
+`›` marks keyboard selection and left-pane focus; mint reverse highlight marks active cockpit session independently. Unfocused sidebar hides pointer, leaves sidebar colors unchanged, and keeps active session highlighted and visible.
+
+Normal sidebar lists sessions in persisted order. Add menu separates `New session` from `Existing session`. New-session flow skips location selection when exactly one local/SSH location is available; multiple locations use dedicated picker, then dedicated name input. Existing-session search lists only untracked sessions. Selecting or creating one persists it and switches immediately. Independently navigable Agents region remains visible below `AGENTS` divider when Add menu is closed. First nine sessions receive shortcut numbers; `K`/`J` updates order. Missing sessions remain launchers: `Enter` uses tmux `new-session -A` to recreate and attach. Sessions persist in `~/.config/letee/sessions`. Only tracked sessions trigger sidebar bell indicators and beeps. Set `LETEE_ASCII=1` for text-only labels and ellipses.
+
+## Agent discovery
+
+Letee discovers coding agents by reading [astatus](https://github.com/julsemaan/astatus) JSON status files. The astatus plugin for your coding agent is **required** for detection — install it in each agent you want letee to discover. See the [astatus documentation](https://github.com/julsemaan/astatus) for full setup instructions and configuration.
+
+### Getting started with coding agents
+
+Agent discovery requires the astatus plugin for your coding agent. The plugin emits JSON status files that letee reads to show agent state in the sidebar.
+
+#### Codex (OpenAI Codex CLI)
+
+```bash
+pip install agent-status
+codex plugin marketplace add julsemaan/astatus
+codex plugin add agent-status@astatus
+```
+
+Start Codex in any repo, open `/hooks`, and trust the agent-status hooks. First prompt starts a detached sidecar that emits 20-second heartbeats.
+
+#### Pi (pi-coding-agent)
+
+```bash
+pi install git:github.com/julsemaan/astatus
+```
+
+Then run `/reload` or restart pi.
+
+#### OpenCode
+
+Add the astatus plugin to `opencode.json`:
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "plugin": ["agent-status-opencode"]
+}
+```
+
+Then start or restart OpenCode. OpenCode installs the plugin from npm automatically.
+
+Run `letee` — agents appear automatically in the Agents sidebar (`C-s a`).
+
+### How agent discovery works
+
+Agent records are read from `$AGENT_STATUS_DIR`, `$XDG_STATE_HOME/agent-status`, or `~/.local/state/agent-status`, in that order. Local and remote running agents updated within 60 seconds are correlated by exact tmux socket and pane ID. Selecting agent navigates to exact server, window, and pane; active agent name and location remain orange independently of keyboard selection. Working agents show `for <duration>`; other states show no duration. Working durations prefer `task.status_timestamp` and fall back to `runtime.updated_at`; unusable optional timestamps omit duration. Each agent row starts with a semantic status icon; working agents use an animated Braille spinner. Focused selection replaces that icon with `›`, and moving focus away restores it. Status icon and text share semantic color; selection cursor stays orange. `LETEE_ASCII=1` uses ASCII icons, spinner frames, and `>` cursor. Attention states remain bold and idle/canceled remain dim without color. Agents are discovered automatically, but only agents in tracked sessions appear. Agents cannot be added, removed, reordered, or killed as favorites.
+
+### Agent alerts
+
+When a tracked agent changes from `working` to `idle`, `completed`, `input-required`, `auth-required`, `failed`, `rejected`, or `canceled`, sidebar beeps once and marks that exact pane/agent with `🔔` (`BELL` in ASCII mode). Initial discovery does not alert. Marker survives later state changes until exact pane opens, is already active during discovery, disappears from discovery, or sidebar restarts.
+
+## Mouse controls
+
+- click session row: select and switch
+- right-click tracked session: open native tmux menu to remove it or kill it with confirmation; right-click does not switch sessions
+- drag tracked session: reorder it; hovering `↑ more` or `↓ more` auto-scrolls, and leaving sidebar drops at current insertion line
+- click `＋ add`, Add choice, or available location row: activate same flow as `Enter`
+- wheel over sidebar: navigate selectable session and host rows
+- right-pane mouse events: forwarded by outer tmux to mouse-aware applications
+- live border dragging: disabled so text selection can cross the sidebar divider without resizing it
+
+Tmux mouse capture may require holding `Shift` for terminal-native text selection.
+
+## Clipboard
+
+Native tmux copy mode forwards copied text through nested sessions using OSC 52. Physical terminal must support and enable OSC 52 clipboard access. letee declares inner clients as `clipboard` capable and sets outer server option `set-clipboard on`; inner tmux configuration remains unchanged, including explicit `set-clipboard off`.
+
+**Security:** `set-clipboard on` permits processes in local and remote panes to set system clipboard through OSC 52. Only connect to trusted hosts and run trusted pane processes.
+
+## Recovery
+
+Press `C-s s` to restart/focus Sessions, `C-s a` to restart/focus Agents, or `C-s +` to open Add session menu. Or rerun:
+
+```sh
+letee
+```
+
+It reuses valid cockpit, repairs broken window, and respawns missing sidebar.
+
+## Development
+
+```sh
+make dev-install
+make test          # unit tests
+make lint          # Ruff
+make coverage      # branch coverage (85% minimum)
+make build-check   # build distributions and validate metadata
+make check         # all quality gates
+```
+
+## License
+
+Licensed under the [Apache License 2.0](LICENSE).
+
+Missing cockpit for switch/create prints:
+
+```text
+No valid letee. Run: letee
+```