sjs/vibetunnel
1
0
Fork 0
mirror of https://github.com/samsonjs/vibetunnel.git synced 2026-04-03 10:55:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
vibetunnel/tty-fwd
History
Mario Zechner 47ccd26416 Fix server working directory corruption and remove duplicate PTY code 
- Fixed sessionId calculation bug in asciinema stream-out events
- Removed ~400 lines of duplicate PTY code from term_socket.rs
- Created reusable spawn_with_pty_fallback function in tty_spawn.rs
- Fixed working directory isolation in session spawning threads
- Ensured static file serving works correctly after session creation

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-19 21:25:49 +02:00
..
src Fix server working directory corruption and remove duplicate PTY code 2025-06-19 21:25:49 +02:00
.gitignore Initial changes for tty forwarding 2025-06-15 21:30:57 +02:00
build-universal.sh build release or debug version based on scheme 2025-06-19 13:02:15 +02:00
Cargo.lock fix: apply formatters to pass CI checks (#19) 2025-06-19 01:39:27 +02:00
Cargo.toml fix: apply formatters to pass CI checks (#19) 2025-06-19 01:39:27 +02:00
clippy.toml lint Rust 2025-06-17 01:03:29 +02:00
README.md Added password protection 2025-06-16 20:27:07 +02:00
rustfmt.toml lint Rust 2025-06-17 01:03:29 +02:00

README.md

tty-fwd

tty-fwd is a utility to capture TTY sessions and forward them. It spawns processes in a pseudo-TTY and records their output in asciinema format while providing remote control capabilities.

Features

  • Session Management: Create, list, and manage TTY sessions
  • Remote Control: Send text and key inputs to running sessions
  • Output Recording: Records sessions in asciinema format for playback
  • Session Persistence: Sessions persist in control directories with metadata
  • Process Monitoring: Tracks process status and exit codes

Usage

Basic Usage

Spawn a command in a TTY session:

tty-fwd -- bash

Session Management

List all sessions:

tty-fwd --list-sessions

Create a named session:

tty-fwd --session-name "my-session" -- vim

Remote Control

Send text to a session:

tty-fwd --session <session-id> --send-text "hello world"

Send special keys:

tty-fwd --session <session-id> --send-key enter
tty-fwd --session <session-id> --send-key arrow_up

Supported keys: arrow_up, arrow_down, arrow_left, arrow_right, escape, enter, ctrl_enter, shift_enter

Process Control

Stop a session gracefully:

tty-fwd --session <session-id> --stop

Kill a session forcefully:

tty-fwd --session <session-id> --kill

Send custom signal to session:

tty-fwd --session <session-id> --signal <number>

HTTP API Server

Start HTTP server for remote session management:

tty-fwd --serve 8080

Start server with static file serving:

tty-fwd --serve 127.0.0.1:8080 --static-path ./web

Cleanup

Remove stopped sessions:

tty-fwd --cleanup

Remove a specific session:

tty-fwd --session <session-id> --cleanup

HTTP API

When running with --serve, the following REST API endpoints are available:

Session Management

  • GET /api/sessions - List all sessions with metadata
  • POST /api/sessions - Create new session (body: {"command": ["cmd", "args"], "workingDir": "/path"})
  • DELETE /api/sessions/{session-id} - Kill session
  • DELETE /api/sessions/{session-id}/cleanup - Clean up specific session
  • POST /api/cleanup-exited - Clean up all exited sessions

Session Interaction

  • GET /api/sessions/{session-id}/stream - Real-time session output (Server-Sent Events)
  • GET /api/sessions/{session-id}/snapshot - Current session output snapshot
  • POST /api/sessions/{session-id}/input - Send input to session (body: {"text": "input"})

File System Operations

  • POST /api/mkdir - Create directory (body: {"path": "/path/to/directory"})

Static Files

  • GET / - Serves static files from --static-path directory

Options

  • --control-path: Specify control directory location (default: ~/.vibetunnel/control)
  • --session-name: Name the session when creating
  • --session: Target specific session by ID
  • --list-sessions: List all sessions with metadata
  • --send-text: Send text input to session
  • --send-key: Send special key input to session
  • --signal: Send custom signal to session process
  • --stop: Send SIGTERM to session (graceful stop)
  • --kill: Send SIGKILL to session (force kill)
  • --serve: Start HTTP API server on specified address/port
  • --static-path: Directory to serve static files from (requires --serve)
  • --cleanup: Remove exited sessions
  • --password: Enables an HTTP basic auth password (username is ignored)

License

Licensed under the Apache License, Version 2.0.