CLI Usage¶
nym-vpnc is the command-line client that communicates with the nym-vpnd daemon via gRPC.
Connection¶
# Connect with default settings
nym-vpnc connect-v2
# Disconnect
nym-vpnc disconnect
# Check connection status
nym-vpnc status
Gateway Management¶
# View current gateway selection
nym-vpnc gateway get
# List gateways by type (mixnet-entry, mixnet-exit, wg)
nym-vpnc gateway list mixnet-exit
# Set entry/exit gateways by country
nym-vpnc gateway set --entry-country DE --exit-country CH
# Set a specific gateway by ID
nym-vpnc gateway set --exit-id <base58-gateway-id>
# Auto-select with random gateways
nym-vpnc gateway set --entry-random --exit-random
Account¶
# Import account recovery phrase
nym-vpnc account set "your twenty four word mnemonic phrase here"
# View account info
nym-vpnc account get
# Remove stored credentials
nym-vpnc account forget
# Rotate WireGuard keys
nym-vpnc account rotate-keys
Tunnel Settings¶
# View tunnel configuration
nym-vpnc tunnel get
# Configure tunnel options
nym-vpnc tunnel set --ipv6 on --two-hop on
# Disable kill-switch (for PBR compatibility)
nym-vpnc tunnel set --killswitch off
# Re-enable kill-switch
nym-vpnc tunnel set --killswitch on
Kill-Switch¶
The kill-switch controls two things:
- Firewall rules — blocks traffic that would bypass the VPN tunnel
- Default route — forces all traffic (0.0.0.0/0) through the tunnel
When on (default), all traffic is forced through the VPN with leak protection. When off, the tunnel is active but only traffic explicitly routed to it (e.g., by PBR) goes through. This is required for compatibility with luci-app-pbr or manual policy-based routing.
Changing the kill-switch requires a reconnect to take effect.
Warning: Disabling the kill-switch means traffic can leak outside the VPN. Only disable this if you are managing routing yourself.
Network Settings¶
# View current network (mainnet, canary)
nym-vpnc network get
# Set network
nym-vpnc network set mainnet
LAN Policy¶
# View current LAN policy
nym-vpnc lan get
# Allow LAN device access while connected
nym-vpnc lan set allow
# Block LAN device access while connected
nym-vpnc lan set block
DNS¶
# View DNS configuration
nym-vpnc dns get
# Set custom DNS servers
nym-vpnc dns set 1.1.1.1 9.9.9.9
# Enable/disable custom DNS
nym-vpnc dns enable
nym-vpnc dns disable
# Clear custom DNS servers
nym-vpnc dns clear
Ad Blocking¶
# View ad-blocking status
nym-vpnc ad-block get
# Enable/disable ad-blocking
nym-vpnc ad-block set enabled
nym-vpnc ad-block set disabled