mirror of
https://github.com/samsonjs/vibetunnel.git
synced 2026-03-28 09:55:53 +00:00
|
|
||
|---|---|---|
| .. | ||
| .claude | ||
| bin | ||
| docs | ||
| node-pty | ||
| scripts | ||
| src | ||
| .gitignore | ||
| .npm-lock-notice | ||
| .npmignore | ||
| .npmrc | ||
| .prebuildrc | ||
| .prettierignore | ||
| .prettierrc.json | ||
| .side-effects-cache.json | ||
| biome.json | ||
| build-custom-node.js | ||
| build-native-clean.sh | ||
| build-native.js | ||
| CLAUDE.md | ||
| custom-node.md | ||
| DEVELOPMENT.md | ||
| fwd-test.ts | ||
| LOGGING_STYLE_GUIDE.md | ||
| package.json | ||
| playwright.config.skip-failing.ts | ||
| playwright.config.ts | ||
| pnpm-lock.yaml | ||
| postcss.config.js | ||
| README.md | ||
| SECURITY.md | ||
| spec.md | ||
| tailwind.config.js | ||
| tsconfig.base.json | ||
| tsconfig.client.json | ||
| tsconfig.json | ||
| tsconfig.server.json | ||
| tsconfig.sw.json | ||
| tsconfig.test.json | ||
| vitest.config.ts | ||
VibeTunnel CLI
Full-featured terminal sharing server with web interface for macOS and Linux. Windows not yet supported.
Installation
npm install -g vibetunnel
Requirements
- Node.js >= 20.0.0
- macOS or Linux (Windows not yet supported)
- Build tools for native modules (Xcode on macOS, build-essential on Linux)
Usage
Start the server
# Start with default settings (port 4020)
vibetunnel
# Start with custom port
vibetunnel --port 8080
# Start without authentication
vibetunnel --no-auth
Then open http://localhost:4020 in your browser to access the web interface.
Use the vt command wrapper
The vt command allows you to run commands with TTY forwarding:
# Monitor AI agents with automatic activity tracking
vt claude
vt claude --dangerously-skip-permissions
# Run commands with output visible in VibeTunnel
vt npm test
vt python script.py
vt top
# Launch interactive shell
vt --shell
vt -i
# Update session title (inside a session)
vt title "My Project"
Forward commands to a session
# Basic usage
vibetunnel fwd <session-id> <command> [args...]
# Examples
vibetunnel fwd --session-id abc123 ls -la
vibetunnel fwd --session-id abc123 npm test
vibetunnel fwd --session-id abc123 python script.py
Features
- Web-based terminal interface - Access terminals from any browser
- Multiple concurrent sessions - Run multiple terminals simultaneously
- Real-time synchronization - See output in real-time
- TTY forwarding - Full terminal emulation support
- Session management - Create, list, and manage sessions
- Cross-platform - Works on macOS and Linux
- No dependencies - Just Node.js required
Package Contents
This npm package includes:
- Full VibeTunnel server with web UI
- Command-line tools (vibetunnel, vt)
- Native PTY support for terminal emulation
- Web interface with xterm.js
- Session management and forwarding
Platform Support
- macOS (Intel and Apple Silicon)
- Linux (x64 and ARM64)
- Windows: Not yet supported (#252)
Documentation
See the main repository for complete documentation: https://github.com/amantus-ai/vibetunnel
License
MIT