mirror of
https://github.com/Termix-SSH/Termix.git
synced 2026-11-02 00:25:24 +00:00
chore: rework plugin readmes, json changelogs and standalone repo setup
This commit is contained in:
LukeGus committed
1 parent
a8f383d2b3
commit
29a946d02e
500 files changed
+6729
-1250
No files matched your search
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"extends": ["@commitlint/config-conventional"],
|
||||
"rules": {
|
||||
"type-enum": [
|
||||
2,
|
||||
"always",
|
||||
[
|
||||
"feat",
|
||||
"fix",
|
||||
"docs",
|
||||
"style",
|
||||
"refactor",
|
||||
"perf",
|
||||
"test",
|
||||
"chore",
|
||||
"revert"
|
||||
]
|
||||
],
|
||||
"subject-case": [0]
|
||||
}
|
||||
}
|
||||
+1
@@ -0,0 +1 @@
|
||||
custom: https://donate.termix.site/
|
||||
@@ -0,0 +1,34 @@
|
||||
# Overview
|
||||
|
||||
_Short summary of what this PR does_
|
||||
|
||||
- [ ] Added: ...
|
||||
- [ ] Updated: ...
|
||||
- [ ] Removed: ...
|
||||
- [ ] Fixed: ...
|
||||
|
||||
# Changes Made
|
||||
|
||||
_Detailed explanation of changes (if needed)_
|
||||
|
||||
- ...
|
||||
|
||||
# Related Issues
|
||||
|
||||
_Link any issues this PR addresses_
|
||||
|
||||
- Closes #ISSUE_NUMBER
|
||||
- Related to #ISSUE_NUMBER
|
||||
|
||||
# Screenshots / Demos
|
||||
|
||||
_(Optional: add before/after screenshots, GIFs, or console output)_
|
||||
|
||||
# Checklist
|
||||
|
||||
- [ ] Code follows project style guidelines
|
||||
- [ ] Supports mobile and desktop UI/app (if applicable)
|
||||
- [ ] Added the change to `CHANGELOG.json`
|
||||
- [ ] `npm run test`, `npm run typecheck` and `npm run validate` pass
|
||||
- [ ] I have read `CONTRIBUTING.md`
|
||||
- [ ] This is not a translation request. See [docs](https://docs.termix.site/translations)
|
||||
@@ -0,0 +1,9 @@
|
||||
node_modules
|
||||
dist
|
||||
coverage
|
||||
*.log
|
||||
.env
|
||||
*.tmxplug
|
||||
*.tmxplug.sig
|
||||
termix-plugin-signing.key
|
||||
.termix-tables-*
|
||||
@@ -0,0 +1 @@
|
||||
npx --no -- commitlint --edit "$1"
|
||||
@@ -0,0 +1 @@
|
||||
npx lint-staged
|
||||
@@ -0,0 +1,4 @@
|
||||
dist
|
||||
coverage
|
||||
node_modules
|
||||
package-lock.json
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"semi": true,
|
||||
"singleQuote": false,
|
||||
"tabWidth": 2,
|
||||
"trailingComma": "all",
|
||||
"printWidth": 80,
|
||||
"arrowParens": "always",
|
||||
"endOfLine": "lf"
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"$schema": "https://raw.githubusercontent.com/Termix-SSH/Termix/main/packages/plugin-sdk/schema/changelog.schema.json",
|
||||
"releases": [
|
||||
{
|
||||
"version": "1.0.0",
|
||||
"changes": [
|
||||
{
|
||||
"type": "added",
|
||||
"text": "Every host's tmux sessions in one place"
|
||||
},
|
||||
{
|
||||
"type": "added",
|
||||
"text": "Live pane previews"
|
||||
},
|
||||
{
|
||||
"type": "added",
|
||||
"text": "Resource use for each session"
|
||||
},
|
||||
{
|
||||
"type": "added",
|
||||
"text": "Search across every pane"
|
||||
},
|
||||
{
|
||||
"type": "added",
|
||||
"text": "Create, rename, split and kill sessions, windows and panes"
|
||||
},
|
||||
{
|
||||
"type": "added",
|
||||
"text": "Attach a terminal in one click"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,7 +0,0 @@
|
||||
# Changelog
|
||||
|
||||
## 1.0.0
|
||||
|
||||
First release, bundled with Termix 2.9.0.
|
||||
|
||||
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.
|
||||
@@ -0,0 +1,22 @@
|
||||
# Contributing to Tmux Monitor
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
npm run build # build into dist/
|
||||
npm run test # run this plugin's tests
|
||||
npm run typecheck # type-check this plugin
|
||||
npm run validate # check manifest.json
|
||||
npm run format # format the code with Prettier
|
||||
```
|
||||
|
||||
## Settings
|
||||
|
||||
### Host
|
||||
|
||||
- **Enable Tmux Monitor:** show this host in the monitor and add its tmux actions to the sidebar
|
||||
- **Enable tmux mouse support:** turn on mouse support when attaching or creating a session
|
||||
|
||||
## Permissions
|
||||
|
||||
- `tmux-monitor.use`: browse and control tmux sessions on hosts with the monitor on. Admins and users have it by default.
|
||||
@@ -1,58 +1,48 @@
|
||||
# Tmux Monitor
|
||||
<div align="center">
|
||||
|
||||
Browse and control tmux sessions, windows and panes across your hosts.
|
||||
<img src="https://raw.githubusercontent.com/Termix-SSH/Termix/main/public/icon.svg" width="120" height="120" alt="Termix Logo" />
|
||||
|
||||
<h1>Tmux Monitor</h1>
|
||||
|
||||
<p>Browse and control tmux sessions across your hosts</p>
|
||||
|
||||
</div>
|
||||
|
||||
<br />
|
||||
|
||||
## Overview
|
||||
|
||||
Tmux Monitor shows the tmux sessions, windows and panes on your hosts and lets you manage them without attaching first.
|
||||
|
||||
<br />
|
||||
|
||||
## Features
|
||||
|
||||
- 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.
|
||||
- Every host's tmux sessions in one place
|
||||
- Live pane previews
|
||||
- Resource use for each session
|
||||
- Search across every pane
|
||||
- Create, rename, split and kill sessions, windows and panes
|
||||
- Attach a terminal in one click
|
||||
|
||||
## Unified monitor
|
||||
|
||||
Open Tmux Monitor from a host action or the command palette. **All hosts**
|
||||
shows an expandable tree for each SSH host with the monitor enabled. Filter
|
||||
by host name or address, or choose **Single host** to use one host at a time.
|
||||
Click a session name or pane to switch the live preview. The tree actions
|
||||
continue to target the host containing that session, even when two hosts
|
||||
have identical session names or pane IDs. The toolbar and output search
|
||||
operate on the selected host.
|
||||
|
||||
The monitor remembers its mode, filter, collapsed hosts, expanded sessions,
|
||||
last host and selected pane locally. An explicit host action takes precedence
|
||||
over the saved host and clears the filter. A saved pane is restored only if
|
||||
it still exists in the host's latest overview.
|
||||
|
||||
Expanded background hosts poll overview and resource metrics independently,
|
||||
with at most four background hosts loading at once. Collapsing or filtering
|
||||
out a background host stops its polling; switching away from the monitor
|
||||
stops all overview/metrics polling. The selected host keeps polling while
|
||||
its preview is active, including when its tree is collapsed. These controls
|
||||
use the existing SSH APIs and require only tmux on the remote hosts, not
|
||||
Auto Tmux.
|
||||
|
||||
## Settings
|
||||
|
||||
### Host
|
||||
|
||||
- Enable Tmux Monitor: show this host in the monitor.
|
||||
|
||||
## Permissions
|
||||
|
||||
- `tmux-monitor.use`: Use Tmux Monitor. Admins and users have it by default.
|
||||
<br />
|
||||
|
||||
## Services
|
||||
|
||||
Provides to other plugins:
|
||||
|
||||
- `tmux.sessions`: find, attach to and create tmux sessions. The terminal uses this to attach to tmux on connect.
|
||||
- `tmux.sessions`: find, attach to and create tmux sessions
|
||||
|
||||
## Development
|
||||
<br />
|
||||
|
||||
```bash
|
||||
npm run build # build into dist/
|
||||
npm run test # run this plugin's tests
|
||||
npm run typecheck # type-check this plugin
|
||||
```
|
||||
## Support
|
||||
|
||||
To report a bug or request a feature, open a [support ticket](https://github.com/Termix-SSH/Support/issues/new/choose). You need to be logged in to GitHub. Please be as detailed as possible, preferably in English.
|
||||
|
||||
For discussions and questions, join the [Discord](https://discord.gg/jVQGdvHDrf) server.
|
||||
|
||||
<br />
|
||||
|
||||
## License
|
||||
|
||||
Distributed under the Apache License Version 2.0. See [LICENSE](https://github.com/Termix-SSH/Termix/blob/main/LICENSE) for more information.
|
||||
@@ -6,12 +6,12 @@
|
||||
"author": {
|
||||
"name": "Termix"
|
||||
},
|
||||
"license": "MIT",
|
||||
"license": "Apache-2.0",
|
||||
"repository": "https://github.com/Termix-SSH/Termix",
|
||||
"category": "Terminal",
|
||||
"icon": "Layers",
|
||||
"engine": {
|
||||
"termix": ">=2.9.0",
|
||||
"termix": ">=26.10.0",
|
||||
"api": "1"
|
||||
},
|
||||
"capabilities": [
|
||||
|
||||
@@ -7,12 +7,17 @@
|
||||
"build": "termix-plugin build",
|
||||
"test": "termix-plugin test",
|
||||
"typecheck": "tsc -p .",
|
||||
"validate": "termix-plugin validate"
|
||||
"validate": "termix-plugin validate",
|
||||
"format": "prettier --write .",
|
||||
"format:check": "prettier --check .",
|
||||
"prepare": "husky || true"
|
||||
},
|
||||
"dependencies": {
|
||||
"lucide-react": "^1.33.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@commitlint/cli": "^21.2.2",
|
||||
"@commitlint/config-conventional": "^21.2.0",
|
||||
"@termix/plugin-sdk": "^1.0.0",
|
||||
"@testing-library/dom": "^10.4.2",
|
||||
"@testing-library/react": "^16.3.3",
|
||||
@@ -20,7 +25,10 @@
|
||||
"@types/react": "^19.2.18",
|
||||
"@types/react-dom": "^19.2.4",
|
||||
"better-sqlite3": "^13.0.3",
|
||||
"husky": "^9.1.7",
|
||||
"jsdom": "^30.0.1",
|
||||
"lint-staged": "^17.2.0",
|
||||
"prettier": "3.9.9",
|
||||
"vitest": "^4.1.11"
|
||||
},
|
||||
"peerDependencies": {
|
||||
@@ -29,5 +37,10 @@
|
||||
"express": "^5.2.1",
|
||||
"react": "^19.2.8",
|
||||
"ssh2": "^1.17.0"
|
||||
},
|
||||
"lint-staged": {
|
||||
"*.{ts,tsx,js,jsx,mjs,cjs,json,css,md}": [
|
||||
"prettier --write"
|
||||
]
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user