chore: simplify plugin readmes, changelogs and manifest descriptions

This commit is contained in:
LukeGus committed 2026-09-27 00:24:48 -05:00
1 parent 7423e33184
commit 8043d6dbdd
96 files changed
+1147 -722

No files matched your search

+2 -9
View File
@@ -2,13 +2,6 @@
## 1.0.0
Bundled with Termix 2.9.0.
First release, bundled with Termix 2.9.0.
- Tmux monitoring moved out of core's own server on port 30010 and now serves
under `/plugin-api/tmux-monitor` through core's connect pipeline.
- Owns its data: core's `tmux_session_tags` table is renamed to
`p_tmux_monitor_session_tags` on first activation, and each host's monitor
switch moves into this plugin's host settings.
- New `tmux-monitor.use` permission, given to the admin and user roles.
- Offers `tmux.sessions` to other plugins, so the terminal can attach to,
create and wait for tmux sessions without importing this plugin.
Browse and control tmux sessions, windows and panes across your hosts. Create, rename and close them, tag sessions and attach a terminal to any pane.
+25 -30
View File
@@ -2,41 +2,36 @@
Browse and control tmux sessions, windows and panes across your hosts.
Bundled with Termix and enabled by default. It imports only
`@termix/plugin-sdk`.
## Features
## What it does
- See the tmux sessions, windows and panes on every host with the monitor on.
- CPU, memory and GPU use for each pane, and search across pane history.
- Create, rename and close sessions and windows, and split and close panes.
- Attach a terminal to any pane.
- Tag sessions with your own labels.
- **Overview**: sessions, windows and panes for every host with the monitor
enabled, refreshed on a poll, with per-pane CPU/memory/GPU metrics and a
search across pane scrollback.
- **Control**: create, rename and kill sessions and windows, split and kill
panes, and attach a real terminal to a pane in place.
- **Tags**: per-user labels on a session, saved per host so everyone who
monitors it can tag it differently.
- **`tmux.sessions`**: a service the ssh-terminal plugin consumes, optionally,
to detect tmux on connect, attach or create a session, and wait for a new
one to appear. The terminal keeps working without this plugin; it just
skips tmux attach.
## Settings
Every command runs over a pooled connection through `ctx.ssh.withConnection`,
so it gets host key checks, auth providers, proxies and jump hosts like every
other transport.
### Host
## Layout
- Enable Tmux Monitor: show this host in the monitor.
manifest.json id, capabilities and what this plugin contributes
src/backend/ activate(ctx), routes, the tmux exec helpers, the service
migrations/ one .sql per dialect, generated from src/backend/tables.ts
src/frontend/ the tab, host action, session tree and pane preview
locales/en.json its strings (English only; the rest are translated)
tests/backend/ vitest, node
tests/frontend/ vitest, jsdom
## Permissions
## Data
- `tmux-monitor.use`: Use Tmux Monitor. Admins and users have it by default.
- `p_tmux_monitor_session_tags`, adopted from core's `tmux_session_tags`.
- Host setting `enableTmuxMonitor`, copied from the `ssh_data` column of the
same name by core's `tmux-monitor-settings-migration.ts`.
## Services
See packages/plugin-sdk/ARCHITECTURE.md for the contract this follows.
Provides to other plugins:
- `tmux.sessions`: find, attach to and create tmux sessions. The terminal uses this to attach to tmux on connect.
## Development
```bash
npm run build # build into dist/
npm run test # run this plugin's tests
npm run typecheck # type-check this plugin
```
See `packages/plugin-sdk/ARCHITECTURE.md` for the plugin contract.