takopi-tunnel 0.1.0

Cloudflared tunnel management plugin for takopi

takopi-tunnel

A takopi plugin for managing cloudflared tunnels from Telegram.

Installation

# Install the plugin
uv pip install takopi-tunnel

# Or for development
uv pip install -e /path/to/takopi-tunnel

Requirements

You need cloudflared installed on your system:

• macOS: brew install cloudflared
• Linux: See Cloudflare downloads
• Binary: Download from GitHub releases

Usage

The plugin adds a /tunnel command to takopi:

Command	Description
/tunnel start <port>	Start a tunnel for the specified port
/tunnel list	Show all active tunnels with URLs and uptime
/tunnel stop <port>	Stop the tunnel for a specific port
/tunnel killall	Stop all active tunnels
/tunnel help	Show help

Example

/tunnel start 3000

Response:

Tunnel started for port 3000:
https://random-words.trycloudflare.com

How It Works

This plugin uses Cloudflare's Quick Tunnels feature, which:

• Requires no Cloudflare account or authentication
• Generates a random *.trycloudflare.com subdomain
• Tunnels are ephemeral and don't persist across restarts

Notes

• Tunnels do not persist across takopi restarts
• Each port can only have one tunnel at a time
• The plugin will notify you if a tunnel crashes unexpectedly