zh command reference
Run zh on the server as any user with sudo rights. It asks for rights when a command needs them.
| Command | What it does |
|---|---|
zh | Clears the console |
zh menu | Opens the menu with all areas, six languages (key L) |
zh help | Lists all commands |
zh status | Short status of server, apps, health and license |
zh doctor [--fix] [--apt] | Runs System Health, optionally with safe repairs and package repairs |
zh speedtest | Measures your internet line |
zh diagkit install | Completes the diagnostics kit |
zh apps | Lists installed apps |
zh apps wire | Connects the apps with each other |
zh apps tune | Applies the TRaSH recommendations |
zh update | Updates CloudZH |
zh upgrade <folder> | Installs a new version from an unpacked installer archive |
zh backup | Creates a backup |
zh perf [--live] [--fix] | Performance diagnosis, live view, relieve SABnzbd |
zh reboot [--in <min>] [--cancel] [--status] | Restarts now or later |
zh poweroff [--in <min>] | Shuts down now or later |
zh vpn install · zh vpn add <name> | Installs WireGuard, adds a device with QR code |
zh unifi install · zh unifi inform | Installs UniFi OS Server, shows or sets the inform address |
zh token | Shows the setup token for the first sign-in |
zh users | Lists dashboard users |
zh rename-user <old> <new> | Renames a user |
zh enable-user <name> | Reactivates a user, also removes an end date |
zh reset-password <name> | Sets a new password |
zh reset-2fa <name> | Removes the second factor of a user |
zh owner transfer <name> | Makes another active admin the owner of the server |
zh terminal status|on|off | Browser terminal; also remote on|off, user <name>, close-all |
zh files off | Turns off the file manager |
zh disk · zh disk mount|unmount|eject <n> | Lists USB disks, mounts or ejects one |
zh website status|build|deploy|on|off | Serves a static website on your main domain, see Domain & HTTPS |
zh ai status|on|off|forget-key | Controls the assistant; only root can lift a block |
zh license | Shows the license of this server |
zh license activate CZL-… · zh license refresh | Activates this server with a license key, fetches a fresh license file |
zh license deactivate | Releases this server, its license key becomes free (same as zh license release) |
zh uninstall | Releases the seat and shows how to remove CloudZH; deletes nothing itself |
zh support | Discord community, documentation and feedback |
sudo zh support access | Let CloudZH support into a terminal on this server for a limited time. You get a one-time code, follow along with zh support watch and end it any time with zh support end. |
sudo zh support access --view | Also lets support see your dashboard, read-only, while the session is connected. Passwords, keys, tokens and e-mail addresses are masked; files, the terminal and the credential vault stay closed. Choose the account with --view-as <user>. |
Language
Messages follow the language you chose in the dashboard. Override it for one command with CZH_LANG=de zh status. Questions show a single letter in your language, for example (y/n), (j/n) or (o/n). One letter is enough, the full word works too; y, yes, n and no always work.