pinggy 0.1.9 → 0.2.0

package/.github/workflows/publish-binaries.yml

@@ -0,0 +1,177 @@
+name: Build and upload bin to S3
+
+on:
+  release:
+    types: [created]
+
+env:
+  S3_BUCKET: public.pinggy.cli.binaries
+
+jobs:
+  Ubuntu:
+    name: Build on ${{ matrix.name }} and upload to GitHub Release
+    runs-on: ${{ matrix.runner }}
+
+    strategy:
+      matrix:
+        include:
+          - name: Ubuntu-x64
+            runner: ubuntu-latest
+
+          - name: Ubuntu-arm64
+            runner: ubuntu-24.04-arm
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+
+      - name: Install dependencies
+        run: npm ci || npm install
+
+      - name: Build (tsup)
+        run: npm run build
+
+      - name: Run caxa build to produce `bin/`
+        run: make pack
+
+      - name: Show bin directory
+        run: ls -R ./bin
+
+      - name: Upload artifact to GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        shell: bash
+        run: |
+          VERSION=$(git describe --tags --always)
+
+          # Extract the single generated file (e.g., pinggy-linux-x64)
+          FILE=$(ls bin)
+
+          echo "Detected build artifact: $FILE"
+
+          # Create release if not exists
+          gh release create "$VERSION" --notes "Release $VERSION" --title "$VERSION" || true
+
+          echo "Uploading $FILE to GitHub Release…"
+          gh release upload "$VERSION" "bin/$FILE" --clobber
+  
+  Windows:
+    name: Build on ${{ matrix.name }} and upload
+    runs-on: ${{ matrix.runner }}
+
+    defaults:
+      run:
+        shell: bash
+
+    strategy:
+      matrix:
+        include:
+          - name: Windows-x64
+            runner: windows-latest
+          
+          - name: Windows-arm64
+            runner: windows-11-arm
+        
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+
+      - name: Install dependencies
+        run: npm ci || npm install
+
+      - name: Build (tsup)
+        run: npm run build
+
+      - name: Run caxa build to produce `bin/`
+        run: make pack
+      
+      - name: See bin directory
+        run: ls -R ./bin
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v2
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: ${{ secrets.AWS_REGION }}
+
+      - name: Upload artifact to GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        shell: bash
+        run: |
+          VERSION=$(git describe --tags --always)
+
+          # Extract the single generated file (e.g., pinggy-windows-x64)
+          FILE=$(ls bin)
+
+          echo "Detected build artifact: $FILE"
+
+          # Create release if not exists
+          gh release create "$VERSION" --notes "Release $VERSION" --title "$VERSION" || true
+
+          echo "Uploading $FILE to GitHub Release…"
+          gh release upload "$VERSION" "bin/$FILE" --clobber
+
+
+  MacOS:
+    name: Build on ${{ matrix.name }} and upload to GitHub Release
+    runs-on: ${{ matrix.runner }}
+
+    strategy:
+      matrix:
+        include:
+          - name: MacOS-x64
+            runner: macos-15-intel
+
+          - name: MacOS-arm64
+            runner: macos-15
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+
+      - name: Install dependencies
+        run: npm ci || npm install
+
+      - name: Build (tsup)
+        run: npm run build
+
+      - name: Run caxa build to produce `bin/`
+        run: make pack
+      
+      - name: See bin directory
+        run: ls -R ./bin
+
+      - name: Upload artifact to GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        shell: bash
+        run: |
+         VERSION=$(git describe --tags --always)
+
+          # Get the file in bin/ (e.g., pinggy-macos-x64)
+          FILE=$(ls bin)
+          echo "Detected build artifact: $FILE"
+
+          # Create release if it does not exist
+          gh release create "$VERSION" --notes "Release $VERSION" --title "$VERSION" || true
+
+          echo "Uploading $FILE to GitHub Release…"
+          gh release upload "$VERSION" "bin/$FILE" --clobber
+

package/Makefile

@@ -0,0 +1,4 @@
+pack:
+	node caxa_build.js
+clean:
+	rm -rf bin

package/README.md

@@ -65,41 +65,75 @@ Basic syntax:
 - user@domain is optional. Domain can be any valid domain supported by the service backend (e.g., ap.example.com).
 
 ### Options
-The CLI supports both SSH-style flags and more descriptive long flags. Below is a consolidated list (only public ones are shown here). For the most up-to-date help, run pinggy --help.
-
-- -R, --R <value>              Local port forwarding (SSH-style).
-  Example: -R0:localhost:3000 forwards tunnel traffic to local port 3000.
-- -L, --L <value>              Web debugger address (SSH-style).
-  Example: -L4300:localhost:4300 starts web debugger on port 4300.
-- -p, --server-port <value>    Pinggy server port (default: 443).
-- --type <value>               Type of connection (e.g., tcp for raw TCP tunnel).
-- -l, --localport <value>      Local endpoint as [protocol:][host:]port.
-  Examples: --localport https://localhost:8000 or -l 3000
-- -d, --debugger <value>       Port for web debugger (e.g., -d 4300).
-- --token <value>              Token for authentication.
-
-Logging:
-- --loglevel <value>           Logging level: ERROR, INFO, DEBUG.
-- --logfile <path>             Path to log file.
-- --v                          Print logs to stdout for Cli.
-- --vv                         Enable detailed logging for the Node.js SDK and Libpinggy.
-- --vvv                        Enable logs from Cli, SDK and Libpinggy.
-
-Config:
-- --saveconf <file>            Create a configuration file based on the provided options.
-- --conf <file>                Load configuration from file; CLI options override it.
-
-File server:
-- --serve <path>               Serve files from a local directory via a simple web server.
-
-Remote control:
-- --remote-management <token>  Enable remote management of tunnels using api key.
-- --manage <addr>              Remote management server (default: dashboard.pinggy.io).
-- --NoTUI                      Disable TUI in remote management mode.
-
-Misc:
-- --version                    Print version and exit.
-- -h, --help                   Show help and exit.
+The CLI supports both SSH-style flags and more descriptive long flags. Below is a consolidated list (only public ones are shown here). For the most up-to-date help, run `pinggy --help`.
+
+### **Port Forwarding**
+| Flag | Description | Example |
+|------|-------------|---------|
+| `-R`, `--R` | Local port forwarding (SSH-style) | `-R0:localhost:3000` |
+| `-L`, `--L` | Web debugger address (SSH-style) | `-L4300:localhost:4300` |
+
+---
+
+### **Connection**
+
+| Flag | Description | Example |
+|------|-------------|---------|
+| `-p`, `--server-port` | Pinggy server port (default: 443) | `--server-port 8080` |
+| `--type` | Type of connection (e.g., `tcp`) | `--type tcp` |
+| `-l`, `--localport` | Local endpoint `[protocol:][host:]port` | `--localport https://localhost:8000` |
+| `-d`, `--debugger` | Port for web debugger | `-d 4300` |
+| `--token` | Token for authentication | `--token abc123` |
+
+---
+
+### **Logging**
+| Flag | Description |
+|------|-------------|
+| `--loglevel` | Logging level: `ERROR`, `INFO`, `DEBUG` |
+| `--logfile` | Path to log file |
+| `--v` | Print logs to stdout |
+| `--vv` | Detailed logs (Node.js SDK + Libpinggy) |
+| `--vvv` | Enable logs from CLI, SDK, and Libpinggy |Libpinggy.
+
+---
+
+### **Config**
+| Flag | Description |
+|------|-------------|
+| `--saveconf <file>` | Create configuration file with provided options |
+| `--conf <file>` | Load configuration from file (CLI flags override) |
+
+---
+
+### **File server**
+| Flag | Description |
+|------|-------------|
+| `--serve <path>` | Serve files from a local directory via simple web server |
+
+---
+
+### **AutoReconnect**
+| Flag | Description |
+|------|-------------|
+| `--autoreconnect`, `-a` | Automatically reconnect tunnel on failure |
+
+---
+
+### **Remote control**
+| Flag | Description |
+|------|-------------|
+| `--remote-management <token>` | Enable remote tunnel management |
+| `--manage <addr>` | Remote management server (default: `dashboard.pinggy.io`) |
+| `--NoTUI` | Disable TUI in remote management mode |
+
+---
+
+### **Misc**
+| Flag | Description |
+|------|-------------|
+| `--version` | Print version and exit |
+| `-h`, `--help` | Show help and exit |
 
 
 ### Extended options
@@ -149,7 +183,7 @@ You can control logs via CLI flags (which override environment variables). If lo
 ```bash
   pinggy -p 3000 --logfile ~/.pinggy/pinggy.log --loglevel INFO --v
 ```
-If you provide --v, --vv, or --vvv without specifying a log level, the default log level is INFO.
+If you provide `--v`, `--vv`, or `--vvv` without specifying a log level, the default log level is INFO.
 
 
 
@@ -166,7 +200,7 @@ pinggy --conf ./myconfig.json -p 8080
 
 ## File server mode
 Serve a local directory quickly over a tunnel:
-  pinggy --serve /path/to/files
+`  pinggy --serve /path/to/files`
 Optionally combine with other flags (auth, IP whitelist) as needed.
 
 
@@ -181,3 +215,5 @@ This package follows semantic versioning. See package.json for the current versi
 
 ## License
 Apache License Version 2.0
+
+

package/caxa_build.js

@@ -0,0 +1,24 @@
+import caxa from 'caxa';
+import { readFileSync } from 'fs';
+
+(async () => {
+  const platform = process.platform;      // win32, linux, darwin
+  const arch = process.arch;              // x64, arm64, ia32
+  
+  const packageJson = JSON.parse(readFileSync('./package.json', 'utf-8'));
+  const version = packageJson.version;
+  
+  const extension =
+    platform === "win32" ? ".exe" :
+    platform === "darwin" ? "" : "";
+
+  await caxa({
+    input: "./",
+    output: `bin/pinggy-${version}-${platform}-${arch}${extension}`,
+    includeNode: true,
+    command: [
+      "{{caxa}}/node_modules/.bin/node",
+      "{{caxa}}/dist/index.js",
+    ],
+  });
+})();