CLI Reference

Complete reference for the v2raytunsetup command-line tool — install, update, backup, and manage V2RayTun.

Overview

v2raytunsetup is the command-line tool for managing V2RayTun panel installations. It is installed automatically by the install script and placed in /usr/local/bin.

Commands

install-panel

Install the V2RayTun panel on the current server.

Bash

v2raytunsetup install-panel

Non-interactive mode:

Bash

V2RAYTUN_PANEL_DOMAIN=panel.example.com \
V2RAYTUN_SUB_DOMAIN=sub.example.com \
v2raytunsetup install-panel

update

Update the panel to the latest version. Pulls new Docker images and restarts services.

Bash

v2raytunsetup update

restart

Restart all panel Docker services.

Bash

v2raytunsetup restart

stop

Stop all panel Docker services.

Bash

v2raytunsetup stop

start

Start all panel Docker services.

Bash

v2raytunsetup start

status

Show the status of all panel Docker services.

Bash

v2raytunsetup status

Example output:

Text

NAME        STATUS          PORTS
backend     Up 3 hours      0.0.0.0:3000->3000/tcp
frontend    Up 3 hours      0.0.0.0:3001->3001/tcp
caddy       Up 3 hours      0.0.0.0:80->80/tcp, 0.0.0.0:443->443/tcp
postgres    Up 3 hours      5432/tcp
redis       Up 3 hours      6379/tcp
rabbitmq    Up 3 hours      5672/tcp, 15672/tcp

backup

Create a full backup of the panel data (database, certificates, configuration).

Bash

v2raytunsetup backup

The backup archive is saved to /opt/v2raytun/backups/ with a timestamped filename.

restore

Restore the panel from a backup archive.

Bash

v2raytunsetup restore /opt/v2raytun/backups/backup-2025-06-10.tar.gz

uninstall

Remove the panel and all its data. You will be prompted to confirm.

Bash

v2raytunsetup uninstall

logs

View live logs from all panel services.

Bash

v2raytunsetup logs

Follow logs for a specific service:

Bash

v2raytunsetup logs backend

version

Print the current version of v2raytunsetup.

Bash

v2raytunsetup version

Global Flags

Flag	Description
`--help`	Show help for any command
`--yes`	Skip confirmation prompts