community/tarmoqchi
1
0
Fork 0
mirror of https://github.com/floss-uz-community/tarmoqchi.git synced 2026-02-15 18:23:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Tarmoqchi - Expose your local HTTP server to the public network. https://tarmoqchi.uz
169 commits 3 branches 3 tags 535 KiB
  • Java 42.3%
  • HTML 32.6%
  • Nix 13.2%
  • Go 10.4%
  • Shell 1.5%
Find a file
Exact
Jamshid 5ff9ee73a1
Some checks failed
Test CI / tests (cli) (push) Has been cancelled
Details
Test CI / tests (server) (push) Has been cancelled
Details
Merge pull request #23 from ezozbek36/fix/backward-compability 
fix: add backward compability
2026-02-04 21:21:14 +05:00
.github/workflows chore: run tests only on main branch 2025-05-05 09:48:48 +05:00
cli fix: add backward compability 2026-02-04 19:26:19 +05:00
server fix: add backward compability 2026-02-04 19:26:19 +05:00
.envrc feat: nix packaging 2025-04-27 21:11:52 +05:00
.gitignore fix: headers issue 2025-09-25 20:43:59 +05:00
build.sh added build.sh 2025-03-21 22:05:53 +05:00
flake.lock feat: nix packaging 2025-04-27 21:11:52 +05:00
flake.nix chore: nixos deployment module for tarmoqchi 2025-04-29 19:41:03 +05:00
install.sh feat: version v2.0.0 2025-05-15 11:20:44 +05:00
LICENSE Rename LICENSE.md to LICENSE 2025-03-17 21:59:49 +05:00
module.nix chore: is not part of tarmoqchi 2025-10-05 04:22:45 +05:00
README.md Update README.md 2025-10-02 22:54:24 +05:00
SECURITY.md Create SECURITY.md 2025-03-20 21:55:18 +05:00

README.md

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/floss-uz-community/tarmoqchi/releases/download/Tarmoqchi-2.0.0/install.sh | sudo bash
Arch linux AUR 
paru -S tarmoqchi
or
yay -S tarmoqchi
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