Skip to content

Wiredoor CLI allows you to connect, expose, and manage nodes and services securely with Wiredoor Server.

Notifications You must be signed in to change notification settings

wiredoor/wiredoor-cli

Repository files navigation

Wiredoor logo

Wiredoor

Expose private services securely through reverse VPN tunnel powered by WireGuard and NGINX.
Open-source | Self-hosted

DocumentationCore ServerCLIHelm Charts


Wiredoor CLI Command Reference

Wiredoor CLI is the command-line interface for interacting with the Wiredoor platform. It provides a simple and secure way to register nodes, expose services, and manage connectivity directly from the terminal.

It allows you to:

  • Easily connect to new node in Wiredoor using admin credentials.
  • Quickly connect a private machine to the Wiredoor network without complex configuration.
  • Expose HTTP or TCP services running on your local/private network with just one command.
  • Enable or disable services on the fly
  • Check VPN status and connection logs
  • Automate service exposure on boot
  • Authenticate via token-based access

This CLI is especially useful for nodes running in headless environments (e.g., servers, containers, Raspberry Pi, etc.).

Installation

You can use the auto-installer:

curl -s https://www.wiredoor.net/install-wiredoor-cli.sh | sh

Or download a package from GitHub Releases.

Command reference

Login and Create Node

The fastest way to onboard a new system as a node. Authenticate with a Wiredoor server using admin credentials and register this node via interactive prompts.

wiredoor login --url https://your-wiredoor-instance-or-ip
  • Prompts for your admin credentials (email/password)
  • Prompts you to assign a name to the node. Defaults to the machine’s hostname.
  • Prompts you if you want to make this a gateway.
  • Network configuration for gateway and traffic.

This command retrieves and saves the node’s token to /etc/wiredoor/config.ini and connect to wiredoor server.

Connect to Wiredoor Node

Establish a VPN connection using saved or provided credentials.

wiredoor connect
wiredoor connect --url=https://wiredoor.example.com --token=ABC123
  • Uses /etc/wiredoor/config.ini by default
  • Optionally override --url and --token

Wiredoor config

Write the server URL and token to the config file without connecting.

wiredoor config --url=https://wiredoor.example.com --token=ABC123
  • Saves config to /etc/wiredoor/config.ini
  • Does not start the connection

Wiredoor Expose HTTP Service

Expose a local HTTP service via Wiredoor.

wiredoor http my-website --domain website.com --port 3000

Optional flags:

  • --path /ui (default: /)
  • --proto https (default: http)
  • --backendHost (useful if acting as a gateway)
  • --allow / --block for IP access control

Wiredoor Expose TCP Service

Expose a generic TCP/UDP service via wiredoor available port.

wiredoor tcp ssh-access --port 22
wiredoor tcp redis --port 6379 --ssl --allowedIps 192.168.0.0/24

Optional flags:

  • --proto tcp|udp (default: tcp)
  • --ssl wrap in TLS
  • --backendHost (useful if acting as a gateway)
  • --allow / --block for IP access control

Wiredoor Status

View current VPN and service status.

wiredoor status
wiredoor status --health
wiredoor status --watch --interval 10

Flags:

  • --health: Health check (exit 0/1)
  • --watch: Continuous monitoring
  • --interval: Poll interval (default: 5s)

Wiredoor disable

Temporarily disable an exposed service by name.

wiredoor disable http my-website
wiredoor disable tcp db-access
  • Blocks public access
  • Use wiredoor enable to restore

Wiredoor enable

Re-enable a previously disabled service.

wiredoor enable http my-website
wiredoor enable tcp db-access
  • Restores service availability
  • Requires existing configuration

Wiredoor disconnect

Stop the active VPN tunnel and disable all services (temporarily).

wiredoor disconnect
  • Does not delete the node configuration
  • Use before maintenance or to restart

Systemd service

If installed via package, Wiredoor includes a systemd service that runs a health-check in background to ensure persistent connectivity:

  • Reconnects automatically if connection drops
  • Verifies service exposure health every 15 seconds
  • Ideal for long-running nodes and production servers

To run wiredoor service start and enable wiredoor.service:

Systemd based systems:

sudo systemctl enable wiredoor
sudo systemctl start wiredoor

OpenRC based systems (Alpine Linux):

chmod +x /etc/init.d/wiredoor
rc-update add wiredoor
rc-service wiredoor start

This keeps the node online across reboots and network changes.

About

Wiredoor CLI allows you to connect, expose, and manage nodes and services securely with Wiredoor Server.

Topics

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Sponsor this project

  •  
  •