Shield CLI

English

简体中文

English

简体中文

Appearance

Changelog ​

All notable changes to Shield CLI are documented here.

v0.3.x latest ​

v0.3.1 — Read-Only Mode for MySQL Plugin ​

Released: 2026-03-24

New Features ​

  • Read-only mode — server-side enforcement for MySQL plugin write query blocking
    • --readonly CLI flag to force read-only mode
    • Read-Only Mode checkbox in Web UI when adding/editing MySQL applications
    • Read-only state passed through the full chain: CLI/Web UI → PluginConfig → plugin backend
    • Frontend badge is display-only — remote users cannot toggle it
    • Backend double enforcement: write queries blocked at both frontend and HTTP handler level

Documentation ​

  • Blog post: Plugin System & MySQL Web Management (rewritten with Web UI as primary workflow)
  • Updated MySQL plugin docs with read-only mode details (both languages)
  • Added --readonly to commands reference

v0.3.0 — Plugin System & MySQL Web Client ​

Released: 2026-03-24

New Features ​

  • Plugin system — extend protocol support via independent binary plugins, zero bloat to the main binary
    • shield plugin add <name> — install plugin (from GitHub Releases or local binary)
    • shield plugin list — list installed plugins
    • shield plugin remove <name> — uninstall plugin
    • Plugins communicate with the main process via stdin/stdout JSON protocol
  • MySQL plugin — browser-based Web database management client
    • shield mysql 127.0.0.1:3306 — one command to expose a MySQL Web management interface
    • Supports mysql and mariadb protocol aliases
    • Web UI features: database browsing, table filtering & pagination, schema viewer, SQL execution
    • Result sorting (click column headers), CSV export, one-click copy
    • Interactive credential input (auto-prompt when --db-user / --db-pass are missing)
    • Compatible with --username / --auth-pass generic auth flags
  • Database connection flags — new --db-user, --db-pass, --db-name flags

Documentation ​

v0.2.x ​

v0.2.6 — TCP/UDP Port Proxy ​

Released: 2026-03-24

New Features ​

  • TCP/UDP port proxy — forward arbitrary TCP/UDP ports through encrypted tunnels
    • shield tcp 3306 — proxy MySQL, Redis, PostgreSQL, or any TCP service
    • shield udp 53 — proxy DNS, Syslog, or any UDP service
    • Port is required (no default port for tcp/udp)
    • Displays connection guide with dedicated domain and port instead of opening a browser
  • UDP over chisel — UDP tunnels use chisel's native /udp remote suffix for proper UDP forwarding

Improvements ​

  • Tunnel activation fix — CLI now calls POST _webgate/api/tunnel (consistent with Web UI) instead of a simple GET request
  • Verbose debug output — -v flag now prints debug logs during the silent setup phase (quick-setup API, tunnel creation, activation)

v0.2.5 — Linux Package Manager Support ​

Released: 2026-03-23

New Features ​

  • APT / YUM repository — install via apt install shield-cli or yum install shield-cli
    • APT repository (Debian/Ubuntu) and YUM repository (RHEL/CentOS/Fedora) hosted on GitHub Pages
    • After adding the repo source, apt upgrade / yum update automatically fetches new versions
  • One-liner repo setup script — setup-repo.sh auto-detects package manager and configures the repository
  • install.sh enhancement — supports --apt, --yum, --dnf flags for quick package manager setup

Documentation ​

  • Added APT / YUM installation instructions to README and install guide (both languages)

v0.2.2 — Docker Support ​

Released: 2026-03-22

New Features ​

  • Docker support — added Dockerfile for containerized deployment
    • Multi-stage build with lightweight Alpine-based image
    • Multi-architecture support (linux/amd64, linux/arm64)
    • --network host mode for accessing host and LAN services
  • Docker image CI pipeline — automated Docker build and push on release
    • Published to Docker Hub (fengyily/shield-cli) and GHCR (ghcr.io/fengyily/shield-cli)
    • Automatic semver tagging (latest, 0.2.2, 0.2)
  • Configurable listen address — new SHIELD_LISTEN_HOST environment variable to customize Web UI bind address (defaults to 127.0.0.1, automatically set to 0.0.0.0 in container)

Documentation ​

v0.2.1 ​

Released: 2026-03-20

New Features ​

  • System service installation — shield install registers Shield as a system service that starts automatically on boot
    • macOS: launchd user agent (no sudo required)
    • Linux: systemd service
    • Windows: Windows Service
  • Custom port support — shield install --port 8182 with automatic port conflict detection and alternative suggestion
  • System tray icon (macOS & Windows) — click to open Dashboard, with Restart and Quit options
  • Async tunnel startup — Web UI starts immediately, main tunnel connects in the background
  • Tunnel status API — GET /api/tunnel endpoint for frontend to poll tunnel readiness

Improvements ​

  • Split goreleaser into desktop (CGO + tray) and Linux (pure Go) builds
  • App connections blocked with clear message while tunnel is still connecting

v0.2.0 ​

Released: 2026-03-19

New Features ​

  • Web UI management platform — browser-based dashboard at localhost:8181
    • Add, edit, delete up to 10 application profiles
    • One-click connect/disconnect with real-time status
    • Encrypted local storage for app configurations
  • Persistent configuration — save application profiles with AES-256-GCM encrypted storage
  • Multi-connection support — up to 3 concurrent active tunnel connections
  • Connection manager — shared main tunnel with per-app dynamic resource tunnels

Improvements ​

  • Redesigned logo and branding
  • Updated README with Web UI screenshots and examples

v0.1.3 ​

Released: 2026-03-18

New Features ​

  • Windows installer — PowerShell one-liner installation script
  • Linux installer — curl-based install script
  • Bilingual README — split into English (README.md) and Chinese (README_CN.md)

Improvements ​

  • Default to visible access mode

v0.1.2 ​

Released: 2026-03-18

New Features ​

  • Scoop package — scoop install shield-cli for Windows
  • deb / rpm packages — native Linux package formats via nfpm
  • curl installer — curl -fsSL ... | sh one-liner for Linux/macOS
  • China CDN mirror — jsDelivr-based install script for users in China

v0.1.1 ​

Released: 2026-03-18

Improvements ​

  • Positional arguments — shield ssh 10.0.0.5:2222 instead of --type ssh --source 10.0.0.5:2222
  • Smart defaults — omit IP for localhost, omit port for protocol default
  • Simplified CLI usage with intuitive address resolution

v0.1.0 ​

Released: 2026-03-18

New Features ​

  • GoReleaser integration — automated cross-platform builds (macOS, Linux, Windows × amd64, arm64)
  • Homebrew tap — brew install shield-cli
  • Automated releases — GitHub Actions CI/CD pipeline

v0.0.1 ​

Released: 2026-03-16

Initial Release ​

  • Core tunnel connectivity via Chisel protocol
  • Supported protocols: SSH, RDP, VNC, HTTP, HTTPS, Telnet
  • AES-256-GCM encrypted credential storage with machine fingerprint binding
  • Visible and invisible access modes
  • Auto-open browser on connection
  • Password masking in all log output
  • CI/CD pipeline with GitHub Actions