quvur-dev 1.0.2 → 1.0.3

package/README.md

@@ -0,0 +1,137 @@
+# 🚰 Quvur CLI
+
+**Quvur** is a lightweight CLI tool that exposes your local development server to the internet through a secure tunnel.
+
+It allows developers to instantly share local services without deploying them.
+
+Common use cases:
+
+- Testing webhooks
+- Sharing a local development server
+- Demonstrating applications
+- Remote debugging
+
+---
+
+# ✨ Features
+
+- 🚀 Fast HTTP tunneling
+- 🌍 Public URLs for local servers
+- 🏷 Custom subdomain support
+- 🔐 Authentication
+- 🔁 Automatic reconnect
+- ⚡ Lightweight CLI
+
+> Currently only **HTTP tunneling** is supported.
+
+---
+
+# 📦 Installation
+
+Install globally using npm:
+
+```bash id="w6j9tt"
+npm install -g quvur-dev
+```
+
+After installation the CLI command will be available:
+
+```bash id="0u7a0p"
+quvur
+```
+
+---
+
+# 🚀 Quick Start
+
+Expose a local server running on port **3000**:
+
+```bash id="6m5aqm"
+quvur http 3000
+```
+
+This creates a public tunnel that forwards traffic to your local server.
+
+---
+
+# 🌍 Custom Subdomain
+
+You can request a specific subdomain using the `-s` option.
+
+Example:
+
+```bash id="fd4d18"
+quvur http 3000 -s myapp
+```
+
+Your application will be accessible through a custom subdomain provided by the Quvur gateway.
+
+---
+
+# 📖 Usage
+
+```bash id="v7m59e"
+quvur <command> [options]
+```
+
+---
+
+# 🧰 Commands
+
+## http
+
+Start an HTTP tunnel to expose a local web server.
+
+```bash id="g3mt6r"
+quvur http <port> [options]
+```
+
+Example:
+
+```bash id="i3qk39"
+quvur http 3000
+quvur http 5173 -s myapp
+```
+
+---
+
+## auth
+
+Authenticate with the Quvur server.
+
+```bash id="8q14o2"
+quvur auth
+```
+
+---
+
+## logout
+
+Remove the stored authentication token.
+
+```bash id="7x6m2o"
+quvur logout
+```
+
+---
+
+## config
+
+Load or reset CLI configuration.
+
+```bash id="9z0m8d"
+quvur config
+```
+
+Reset configuration:
+
+```bash id="7d5a1s"
+quvur config --reset
+```
+
+---
+
+# 📌 Notes
+
+- Only **HTTP tunneling** is currently supported.
+- TCP tunneling may be added in future releases.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quvur-dev",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "A lightweight developer tunneling CLI that securely exposes local HTTP and TCP services to the internet via a remote gateway.",
   "license": "ISC",
   "author": "Muhammadali Yuldoshev <mukhammadaliweb@gmail.com>",