mirror of
https://github.com/samsonjs/vibetunnel.git
synced 2026-03-25 09:25:50 +00:00
d4b7962800
Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: Alex Fallah <alexfallah7@gmail.com>
49 lines
No EOL
2.1 KiB
Text
49 lines
No EOL
2.1 KiB
Text
# Welcome to VibeTunnel Documentation
|
|
|
|
VibeTunnel is a powerful terminal sharing application that allows you to access your terminal sessions through any web browser. Whether you're on macOS, Linux, iPad, iPhone, or any other device with a web browser, VibeTunnel makes your terminal accessible from anywhere.
|
|
|
|
## Key Features
|
|
|
|
- **Remote Terminal Access**: Access your terminal from any web browser
|
|
- **Cross-Platform**: Native macOS app with Swift/SwiftUI, plus Linux support via npm package
|
|
- **Secure Connection**: End-to-end encrypted terminal sessions
|
|
- **Multi-Device**: Works on iOS, iPadOS, and any modern web browser
|
|
- **Real-time Sync**: Changes sync instantly across all connected devices
|
|
- **Headless Mode**: Run on servers and cloud instances without a GUI
|
|
|
|
## Quick Start
|
|
|
|
### For macOS
|
|
1. [Download VibeTunnel](https://vibetunnel.com/download) for macOS
|
|
2. Launch the app and create your first terminal session
|
|
3. Access your terminal from any device at your unique VibeTunnel URL
|
|
|
|
### For Linux & Headless Environments
|
|
1. Install via npm: `npm install -g vibetunnel`
|
|
2. Run the server: `vibetunnel-server`
|
|
3. Access your terminal at `http://localhost:4020`
|
|
|
|
## Documentation Overview
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Getting Started" icon="rocket" href="/docs/project-overview">
|
|
Installation guides and your first steps with VibeTunnel
|
|
</Card>
|
|
<Card title="Architecture" icon="building" href="/docs/ARCHITECTURE">
|
|
Learn about VibeTunnel's system design and technical details
|
|
</Card>
|
|
<Card title="Development" icon="code" href="/docs/development">
|
|
Build, test, and contribute to VibeTunnel
|
|
</Card>
|
|
<Card title="API Reference" icon="book" href="/docs/spec">
|
|
Complete API documentation and specifications
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## Join Our Community
|
|
|
|
- [GitHub](https://github.com/amantus-ai/vibetunnel) - Star us on GitHub
|
|
- [Discord](https://discord.gg/vibetunnel) - Join our Discord community
|
|
- [Twitter](https://twitter.com/vibetunnel) - Follow us for updates
|
|
|
|
Ready to get started? Check out our [installation guide](/mac/README) or dive into the [architecture overview](/docs/ARCHITECTURE). |