Skip to content
Back to search

TMX

TMX is a modern desktop terminal client for SSH workflows, built on Electron + React. It bundles a real persistent terminal (node-pty / ssh2 / xterm.js), a host manager, SFTP, snippets, an AI copilot and a built-in MCP server into a single cross-platform app (macOS / Windows / Linux).

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/clawuv--tmx/badge.svg)](/listings/clawuv--tmx)

HTML

<a href="/listings/clawuv--tmx"><img src="/api/listings/clawuv--tmx/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Requirements: Node.js >= 20.19.0 (or >= 22.12.0) and pnpm.

# clone the project
git clone https://github.com/clawuv/TMX.git

# enter the project directory
cd TMX

# install dependencies (native addons are rebuilt automatically)
pnpm install

# start development
pnpm dev

> Native addons (node-pty, better-sqlite3, ssh2) target Electron's ABI. If they act up after an Electron upgrade, run `pnpm rebuild:natives`.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 97 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # TMX
  2. [![GitHub license](https://img.shields.io/github/license/clawuv/TMX?color=fa6470)](https://github.com/clawuv/TMX/blob/main/LICENSE)
  3. [![GitHub release](https://img.shields.io/github/v/release/clawuv/TMX?color=8b5cf6)](https://github.com/clawuv/TMX/releases)
  4. [![Required Node.js >= 20.19.0 || >= 22.12.0](https://img.shields.io/static/v1?label=node&message=%3E=20.19.0%20||%20%3E=22.12.0&logo=node.js&color=3f893e)](https://nodejs.org/about/releases)
  5. English | [简体中文](README.zh-CN.md)
  6. TMX is a modern desktop terminal client for SSH workflows, built on Electron + React. It bundles a real persistent terminal (node-pty / ssh2 / xterm.js), a host manager, SFTP, snippets, an AI copilot and a built-in MCP server into a single cross-platform app (macOS / Windows / Linux).
  7. ## Screenshots
  8. | Terminal | SFTP |
  9. |---|---|
  10. | ![Terminal](docs/screenshots/terminal.png) | ![SFTP](docs/screenshots/sftp.png) |
  11. | **Themes & preferences** | **Command palette** |
  12. | ![Themes](docs/screenshots/settings-themes.png) | ![Command palette](docs/screenshots/command-palette.png) |
  13. ## Features
  14. - **SSH & local terminals** — real pty sessions powered by node-pty (local shell) and ssh2 (remote hosts). Sessions stay alive per tab (scrollback, vim and running jobs survive tab switches), with split panes and a PuTTY-style workflow: copy on select, right-click to paste.
  15. - **Host manager** — organize connections in groups with credentials (password, Ed25519 / private key, passphrase), sorted and searchable.
  16. - **SFTP** — browse the remote file tree, upload/download with progress and cancellation, plus a local filesystem browser for quick uploads.
  17. - **Snippets** — save frequently used commands and run them in any session.
  18. - **AI Copilot** — a built-in assistant drawer for generating and explaining commands.
  19. - **API batch testing** — fire a set of HTTP requests and inspect results, useful for backend smoke tests.
  20. - **System monitor** — live top-process view for the local machine.
  21. - **Built-in MCP server** — TMX exposes a local stdio [Model Context Protocol](https://modelcontextprotocol.io) server so external AI clients (Claude, Cursor, …) can drive your terminals: `list_hosts`, `list_sessions`, `exec_command`, `send_session_input`, `read_session_output`, `run_snippet`, `sftp_list`, `sftp_read_file`.
  22. - **ZMODEM** — sz/rz transfers straight inside the terminal.
  23. - **Theming & preferences** — 5 curated themes, terminal font/line-height/cursor customization, configurable scrollback, all stored in local SQLite (hosts, bookmarks, snippets, preferences).
  24. - **Desktop feel** — native menus and context menus, window state restore, quit confirmation when live SSH sessions would be dropped, i18n (简体中文 / English), auto-update via electron-updater.
  25. ## Tech Stack
  26. Electron 42 · React 19 · Vite 8 · TypeScript · TailwindCSS v4 · xterm.js 6 · node-pty · ssh2 · better-sqlite3 · electron-builder
  27. ## Quick Start
  28. Requirements: Node.js >= 20.19.0 (or >= 22.12.0) and pnpm.
  29. ```sh
  30. # clone the project
  31. git clone https://github.com/clawuv/TMX.git
  32. # enter the project directory
  33. cd TMX
  34. # install dependencies (native addons are rebuilt automatically)
  35. pnpm install
  36. # start development
  37. pnpm dev
  38. ```
  39. > Native addons (node-pty, better-sqlite3, ssh2) target Electron's ABI. If they act up after an Electron upgrade, run `pnpm rebuild:natives`.
  40. ## Available Scripts
  41. - `pnpm dev`: start the Vite dev server and launch the app.
  42. - `pnpm build`: build the renderer and package the app with electron-builder (output in `release/${version}`).
  43. - `pnpm preview`: preview the production web build locally.
  44. - `pnpm test`: run Vitest unit tests.
  45. - `pnpm test:e2e`: build the test-mode bundle and run Playwright tests.
  46. - `pnpm typecheck`: run the TypeScript type checker.
  47. - `pnpm rebuild:natives`: force-rebuild native addons against Electron's ABI.
  48. ## Build & Release
  49. Pushing a `v*` tag (e.g. `v1.0.0`) triggers the [Build and Release](.github/workflows/build.yml) workflow, which packages macOS (dmg/zip), Windows and Linux artifacts via electron-builder and attaches them to a GitHub Release.
  50. ## Project Structure
  51. ```tree
  52. ├── build/ Packaging assets (app icons)
  53. ├── dist-electron/ Compiled Electron output (generated)
  54. ├── electron/ Main-process, preload and MCP server source
  55. │ ├── main/ Window, terminal/SFTP/SQLite/MCP IPC, menus, updater
  56. │ ├── mcp/ Standalone stdio MCP server (dist-electron/mcp/server.mjs)
  57. │ └── preload/ Preload bridge exposed to the renderer
  58. ├── public/ Static assets
  59. ├── src/
  60. │ ├── tmx/ Application source (components, i18n, data, utils)
  61. │ ├── components/ Auto-update modal component
  62. │ └── type/ Shared renderer types
  63. └── test/ Unit and end-to-end tests
  64. └── e2e/
  65. ```
  66. Files under `electron/` are compiled into `dist-electron/`.
  67. ## Security Note
  68. The `renderer: {}` preset in `vite.config.ts` is only a Vite adapter that polyfills Electron, Node.js APIs and native modules for the renderer process. It is not the same as enabling Node integration. If you want direct Node.js access in the renderer, enable `nodeIntegration` in the `BrowserWindow` webPreferences in the main process and review the security impact carefully.
  69. ## License
  70. [MIT](LICENSE)

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.