https://github.com/mertssmnoglu/warp-tui
Unofficial Cloudflare Zero Trust WARP Terminal UI
https://github.com/mertssmnoglu/warp-tui
cloudflare-warp cloudlfare-warp-tui cloudlfare-zero-trust ratatui terminal-user-interface tui tui-rs warp warp-tui
Last synced: about 2 months ago
JSON representation
Unofficial Cloudflare Zero Trust WARP Terminal UI
- Host: GitHub
- URL: https://github.com/mertssmnoglu/warp-tui
- Owner: mertssmnoglu
- License: mit
- Created: 2025-07-06T14:37:35.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-08-25T04:02:11.000Z (2 months ago)
- Last Synced: 2025-08-27T16:51:42.068Z (2 months ago)
- Topics: cloudflare-warp, cloudlfare-warp-tui, cloudlfare-zero-trust, ratatui, terminal-user-interface, tui, tui-rs, warp, warp-tui
- Language: Rust
- Homepage:
- Size: 110 KB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# warp-tui
A terminal user interface (TUI) for managing Cloudflare WARP VPN connections.
Built with Rust and [Ratatui], `warp-tui` provides a real-time, interactive terminal interface for monitoring and controlling your WARP connection status without relying on GUI applications.
## Features
- **Real-time Status Monitoring**: Live updates of WARP connection state with color-coded indicators
- **Interactive Controls**: Connect, disconnect, and refresh WARP status directly from the terminal
- **Minimal Resource Usage**: Lightweight application with < 10MB memory footprint
- **Cross-platform Support**: Works on Linux, macOS, and Windows
- **Auto-refresh**: Configurable periodic status updates (default: 1000ms)
## Prerequisites
- [Cloudflare WARP](https://developers.cloudflare.com/warp-client/) must be installed
- `warp-cli` must be available in your system PATH
## Installation
### From Source
```bash
git clone https://github.com/mertssmnoglu/warp-tui.git
cd warp-tui
cargo install --path .
```
### Using Cargo
```bash
cargo install warp-tui
```
## Usage
Simply run the application:
```bash
warp-tui
```
## Create a Desktop entry
You can create a Linux desktop entry for `warp-tui` using the provided script:
```shell
chmod +x scripts/generate-warp-tui-desktop.sh
./scripts/generate-warp-tui-desktop.sh
```
### Controls
- **C** - Connect to WARP
- **D** - Disconnect from WARP
- **R** - Refresh status manually
- **Q/Esc/Ctrl+C** - Quit application
## Development
### Building
```bash
cargo build
```
### Running
```bash
cargo run
```
### Testing
```bash
cargo test
```
## Technical Stack
- **Language**: Rust (Edition 2024)
- **TUI Framework**: Ratatui 0.29.0
- **Terminal Handling**: Crossterm 0.28.1
- **Async Runtime**: Tokio 1.0
- **Error Handling**: color-eyre, thiserror
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
Copyright (c) Mert Şişmanoğlu
This project is licensed under the MIT license ([LICENSE] or )
[Ratatui]: https://ratatui.rs
[LICENSE]: ./LICENSE