@snomiao/wtx
v0.3.0
Published
Bun PTY WebSocket server with replay buffer + tmux-free session management
Maintainers
Readme
wtx
Bun PTY WebSocket server with replay buffer + wtx CLI.
Install
bun add wtxLibrary usage
import { startTerminalWS, createSession } from "wtx";
startTerminalWS(); // listens on TERMINAL_WS_PORT (default 3004)CLI usage
bunx wtx # or: bun ./node_modules/wtx/src/cli.tsEnv
| var | default | purpose |
| ------------------ | --------------- | --------------------------------------------------------------------- |
| TERMINAL_WS_PORT | 3004 | WS server port |
| WTX_DEFAULT_CWD | process.cwd() | fallback cwd for new sessions |
| WTX_REPO_BASE | (unset) | enables /status/:owner/:repo resolved under <base>/<owner>/<repo> |
API
startTerminalWS()— start the WS servercreateSession(cwd, sessionKey?)— create or attach to a tmux-free PTY sessionhasSession(sessionKey)— check if a session existsgetTerminalStatusForRepo(repoFolder)— busy/idle statusgetTermSummaryForCwd(cwd)— terminal log summary
