Skip to content

Nergis0318/TryCloudflareGUI

Repository files navigation

TryCloudflareGUI

TryCloudflareGUI is a desktop application for creating and managing temporary TryCloudflare tunnels from a graphical interface.

It wraps cloudflared tunnel --url in an Electron app, so you can expose local development servers without memorizing CLI commands.

image

Features

  • Detects an existing cloudflared installation or downloads the binary for you.
  • Creates, edits, starts, stops, and deletes tunnel configurations.
  • Shows live tunnel status and generated trycloudflare.com URLs.
  • Opens generated tunnel URLs in the system browser.
  • Includes quick-start presets for common local frameworks and servers.
  • Supports HTTP, HTTPS, TCP, and SSH targets.
  • Supports disposable tunnels that are not saved after the app exits.
  • Provides multilingual UI support through i18next.

Tech Stack

  • Electron
  • React
  • TypeScript
  • Vite
  • Bun
  • electron-builder
  • i18next / react-i18next

Prerequisites

  • Bun for installing dependencies and running scripts.
  • Internet access when the app needs to download cloudflared.
  • A local service to expose, such as http://localhost:3000.

cloudflared does not have to be installed manually. The app checks for a system installation first, then downloads an app-managed binary if needed.

Getting Started

Install dependencies:

bun install

Start the app in development mode:

bun run dev

This starts the Vite dev server and launches Electron after the renderer is available.

Scripts

Command Description
bun run dev Start Vite and Electron together for development.
bun run dev:vite Start only the Vite renderer dev server.
bun run dev:electron Compile the main process and launch Electron.
bun run build Build the renderer and compile the Electron main process.
bun run build:main Compile only the Electron main process.
bun run build:electron Build and package the app with electron-builder.
bun run preview Preview the built Vite renderer.
bun run generate-icons Generate app icons from the source icon asset.

Building

Create a production build:

bun run build

Package the Electron app:

bun run build:electron

Packaged outputs are written to release/. The electron-builder configuration targets NSIS on Windows, DMG on macOS, and AppImage on Linux.

Project Structure

.
├── .github/workflows/    # CI and release workflows
├── resources/            # Application icons and packaged resources
├── scripts/              # Utility scripts
├── src/main/             # Electron main process, IPC, tunnel management
├── src/renderer/         # React renderer application
├── package.json          # Scripts, dependencies, electron-builder config
└── README.md

Usage Notes

  • TryCloudflare URLs are temporary and generated by Cloudflare when a tunnel starts.
  • Saved tunnel configurations are stored in Electron's app data directory.
  • Disposable tunnels are intentionally excluded from saved tunnel data.
  • Running tunnels are stopped when the application exits.
  • This app is intended for local development and testing workflows, not for production ingress.

License

This project is licensed under the GPL-3.0 license.

About

Easy to use TryCloudflare with GUI

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors