--- title: The vpx command line description: Control 12VPX NEO from a terminal on Windows, macOS, Linux and OpenWrt with the vpx command, from connecting and routing to routers and collecting a report for support. --- On Windows, macOS, Linux and OpenWrt, 12VPX NEO comes with the `vpx` command. It controls the same background service as the desktop app and the web interface, so a change you make in one shows in the others. Closing the terminal doesn't disconnect; `vpx disconnect` does. AUTOMATIC_TABLE_OF_CONTENTS ## Getting started `vpx --help` lists every command in your version, and `vpx --help` explains one command. In Windows PowerShell, type `vpx.exe` instead of `vpx` if `vpx` alone doesn't work. In the examples below, replace words in capitals, such as `SERVER_ID`, with your own value. Put web addresses and passwords in single quotes. Everyday commands don't need administrator or root rights. ## Everyday commands | Task | Command | | --- | --- | | Add your service | `vpx login 'SUBSCRIPTION_URL'` | | List servers | `vpx servers`, or `vpx servers --country JP`, or `vpx servers --search NAME` | | Connect with Automatic | `vpx connect` | | Connect to one server | `vpx connect SERVER_ID` | | Choose the Automatic region | `vpx auto region jp` (`us`, `eu`, `jp`, `any` or `favorites`) | | Star or unstar a server | `vpx favorite SERVER_ID` or `vpx favorite SERVER_ID --remove` | | Show the connection | `vpx status` | | Show your public IP address | `vpx ip --refresh` | | Disconnect | `vpx disconnect` | | Open the web interface | `vpx open` | | Show your account | `vpx account` | | List your account's devices | `vpx account-devices` | | Sign this device out | `vpx logout` | Your setup link is private. Commands you type may stay in your shell history, so clear it on a shared computer. ## Routing and capture | Task | Command | | --- | --- | | Show or change the routing mode | `vpx mode`, `vpx mode full`, `vpx mode china` or `vpx mode ai` | | List manual rules | `vpx rules list` | | Send a domain and everything under it direct | `vpx rules add general direct suffix example.com` | | Send one exact name through the VPX service | `vpx rules add general tunnel exact www.example.com` | | Remove a rule | `vpx rules remove RULE_ID`, using the ID from `vpx rules list` | | Add and use a Rocket config | `vpx rocket add 'CONFIG_URL'`, then `vpx rocket list` and `vpx rocket use CONFIG_ID` | | Stop using a Rocket config | `vpx rocket off` | | See how AI routing handled a site | `vpx ai activity` or `vpx ai explain example.com` | | Change the capture mode | `vpx capture tun`, `vpx capture tproxy` or `vpx capture proxy-only` | A rule is written as `vpx rules add SCOPE ROUTE TYPE VALUE`: - **Scope:** `general` (every mode) or `ai-only` - **Route:** `direct` or `tunnel` (through the VPX service) - **Type:** `suffix`, `exact`, `keyword`, `cidr` or `geoip` [Routing in 12VPX NEO](/en/docs/12vpx-neo/routing) explains what each choice does. ## Other settings | Setting | Commands | | --- | --- | | Ad blocking | `vpx ad-blocking` shows it; `vpx ad-blocking normal` (or `off`, `light`, `pro`) changes it; `vpx ad-blocking refresh` updates the list | | Outbound Optimization | `vpx outbound-optimization`, `vpx outbound-optimization throughput` or `vpx outbound-optimization latency` | | Restore Connection on Startup | `vpx restore-connection on`, `off` or `status` | | DNS Leak Protection | `vpx dns-leak on`, `off` or `status` | | Kill Switch | `vpx kill-switch on`, `off` or `status` | | Restore Internet | `vpx restore-internet` | | LAN Proxy Access | `vpx lan-proxy on`, `off` or `status` | | Home Node | `vpx home-server enable`, `disable` or `status` | | Computer time | `vpx clock`, or `vpx clock --refresh` to check again | | Show all settings | `vpx settings` | [Ad blocking, Kill Switch and other settings](/en/docs/12vpx-neo/settings) explains each setting. ## Routers and gateways On OpenWrt and Linux: | Task | Command | | --- | --- | | Turn on Router Mode for networks | `vpx router enable --lan lan,guest` | | Turn off Router Mode | `vpx router disable` | | LAN DNS on a Linux gateway | `vpx router dns`, `vpx router dns on` or `vpx router dns off` | | List excluded devices | `vpx devices` | | Exclude a device | `vpx devices add 192.168.1.50 'Living room TV'` | | Stop excluding it | `vpx devices remove 192.168.1.50` | `lan,guest` are OpenWrt network names; on Linux, use the names of your network adapters. See [12VPX NEO on a router](/en/docs/12vpx-neo/router). ## Control another device Put the device's address and login before the command: ```sh vpx --daemon http://192.168.1.1:9847 --user root --password 'ROUTER_PASSWORD' status ``` For an OpenWrt router, the login is `root` with the router's own password. For another computer, it is the username and password set under remote control there. Add the same options to every command meant for that device; without them, `vpx` controls the computer you type on. See [Web interface and remote control](/en/docs/12vpx-neo/remote-control). | Task | Command | | --- | --- | | Show remote control settings | `vpx listen` | | Turn on remote control of this computer | `vpx --user admin --password 'PASSWORD' listen INTERFACE` | | Turn it off | `vpx listen --disable` | | Forget the remote control password | `vpx reset-password` | ## Updates | Task | Command | | --- | --- | | Check for an update now | `vpx update --check` | | Install a downloaded update | `vpx update` | | Follow Stable or Beta updates | `vpx update --channel stable` or `vpx update --channel beta` | | Show the version | `vpx version` | On OpenWrt, update through the router's package manager instead. See [Updating on OpenWrt](/en/docs/12vpx-neo/router#updating-on-openwrt). ## When something goes wrong Before you change settings or reconnect, save a report: ```sh vpx diagnostics > vpx-diagnostics.json ``` The report only reads what 12VPX NEO already knows. It changes nothing and leaves out your setup link and passwords. You can send it to support, together with what you were doing, the time it happened and the exact error message. `vpx diagnostics --explain` prints a troubleshooting guide, even without an internet connection. `vpx logs` shows recent events, and `vpx logs --follow` keeps showing new ones while you try again. Logs can contain the names of sites you visited, so read them before you share them. To contact support from the terminal, see `vpx support --help`. Those commands really send your message or logs. [Support, logs and your account](/en/docs/12vpx-neo/support) explains the other ways to reach us. On Windows, `vpx repair-driver` runs the [driver repair](/en/docs/12vpx-neo/settings#repair-vpn-driver-windows).