trqsh · Python

Public URLs for local development. Installed with pip or pipx.

Share development servers, receive webhooks and inspect traffic from an interactive terminal. This package installs the native CLI; the desktop app is a separate download.

CLI 0.2.5 connects to https://tunnel.trqsh.uz and uses authenticated WebSocket transport through wss://tunnel.trqsh.uz/_trqsh/agent. Direct QUIC/TCP connections remain available with --server host:port. Public tunnel URLs need wildcard DNS/TLS and edge ingress in addition to the control-plane hostname.

Quick start · First launch · Commands · Configuration · Troubleshooting

Quick start

Install into an isolated environment with pipx:

pipx install trqsh
trqsh --version
trqsh

Or install with your Python environment:

python -m pip install trqsh
python -m trqsh --version
python -m trqsh

The native CLI downloads on first use, including the first version check. Installing the Python package itself does not open the setup guide. Once signed in, use trqsh http 3000 to start a local web tunnel.

Requirements

The launcher uses the Python standard library and has no third-party runtime dependencies.

First launch

Run trqsh in an interactive terminal. On a fresh configuration, the welcome guide offers browser sign-in, a masked API-key field, or Set up later. After signing in, choose a local HTTP port to expose or open the console.

trqsh / welcome
Bring your localhost online.

> Sign in with browser
  Use an API key
  Set up later

Illustrative welcome screen. Appearance adapts to your terminal.

Reopen the guide with trqsh setup or /setup inside the console. Existing configurations and explicit commands such as trqsh http 3000 keep their normal startup behavior. A tunnel starts only after you request it.

Everyday commands

Enter these commands inside the trqsh console:

Protocol access, reserved subdomains and custom domains depend on the service configuration and your account's entitlements. Closing the console alone does not stop the background daemon.

Installation experience

trqsh / install
Localhost, online.

[ok] Platform    windows / amd64
[ok] Release     vX.Y.Z
[..] Downloading 6.4 / 12.8 MB

Illustrative progress output. Actual releases and byte counts are shown during installation.

The wrapper detects your platform, downloads the native archive, verifies SHA-256, stages the binary and reports its location. Suitable terminals show measured byte progress; CI and redirected output receive plain lines. Package installation never asks for credentials or starts a tunnel.

Missing or mismatched checksums stop installation by default. Interrupted downloads and extraction leave an existing binary intact. Archive integrity and release-origin verification are separate: see the Sigstore verification instructions for the latter.

Configuration

Agent settings use ~/.trqsh/trqsh.yml by default. Select another file with trqsh --config PATH or TRQSH_CONFIG. See the configuration guide.

Update

Use the package manager you installed with:

# pipx
pipx upgrade trqsh

# pip
python -m pip install --upgrade trqsh

The console also supports /update check and /update. Restart after a successful update. Cached binaries older than the package are replaced; newer self-updates are retained unless TRQSH_VERSION explicitly pins another release. Opening the updated console restarts an older CLI daemon. Saved hosted endpoints migrate to tunnel.trqsh.uz; custom endpoints, credentials and tunnel definitions are preserved.

Use one package manager for the global command. When switching from npm to pip, remove the npm launcher with npm uninstall -g @trqsh-uz/trqsh. Check where.exe trqsh on Windows or command -v trqsh on macOS/Linux if an older installation still appears. python -m trqsh --version explicitly selects the current Python environment's package.

Uninstall

To clear local credentials, configuration and caches, run these commands inside the console before removing the package:

/uninstall
/uninstall yes

The confirmation stops tunnels and removes local data; it does not delete your cloud account. Then use the original package manager:

# pipx
pipx uninstall trqsh

# pip
python -m pip uninstall trqsh

Package removal alone leaves separate agent data and the native binary cache.

Troubleshooting

On Windows, the pip wrapper attempts to repair the user Scripts PATH when it can locate the launcher. This is best-effort; reopen the terminal after a reported change. pipx manages its own PATH.

Package layout

src/trqsh/__main__.py   Console and python -m trqsh entry point
src/trqsh/_runtime.py   Download, verification, cache and launch support
src/trqsh/_ui.py        Terminal installer presentation
src/trqsh/__init__.py   Python package version

The binary cache is ~/.cache/trqsh/<version>/, or $XDG_CACHE_HOME/trqsh/<version>/ when configured. Agent configuration and credentials are stored separately.

Documentation · CLI releases · Report an issue · Source

Created by Otabek Hamroqulov. Licensed under Apache-2.0.