Skip to content

floss-uz-community/tarmoqchi

Repository files navigation

banner

Tarmoqchi - The HTTP Tunneling Tool

Feature Overview

  • Expose your local server to the internet easily.
  • Access your local services from anywhere.
  • No need for complex configurations or setups.
  • Simple command-line interface.

Installation and updating

macOS and linux
curl -fsSL https://github.com/jamshid-elmurodov/tarmoqchi/releases/download/Tarmoqchi-2.0.0/install.sh | sudo bash
Windows Download the latest exe from the [release page](https://github.com/floss-uz-community/tarmoqchi/releases/tag/Tarmoqchi-2.0.0)

Usage

First, obtain your personal auth token by logging in at tarmoqchi.uz

tarmoqchi --auth <AUTH_TOKEN>

Expose your local service to the internet:

tarmoqchi --port <YOUR_PORT>

Replace YOUR_PORT with the local port number your service is running on (e.g., 8080, 3000, etc.).

You can also specify a custom subdomain:

tarmoqchi --port <YOUR_PORT> --sd <YOUR_SUBDOMAIN>

Replace YOUR_SUBDOMAIN with the desired subdomain name. For example:

tarmoqchi --port 8080 --sd mycustomsubdomain

You can stop the tunnel by pressing Ctrl + C in the terminal.


Other Options

Show version information

tarmoqchi --version

Show help information

tarmoqchi --help

footer-banner