The xenopanel command line

Run every XenoPanel command from Terminal, preview changes with --dry-run, and script it with --json and fixed exit codes.

4-minute read Applies to XenoPanel 1.0.0 Updated

The xenopanel command ships inside the app and runs the same code: every control in the app runs one of its commands.

The commands

Terminal
$ xenopanel ssh setup <server> --host <address>
$ xenopanel server add|list|status|check|provision|update <server>
$ xenopanel client add|list|enable|disable|remove <client>
$ xenopanel client key add|list|remove <client>
$ xenopanel site add|list|status|php|cloudflare-only|enable|disable|remove <domain>
$ xenopanel db add|list|remove <database>
$ xenopanel db user add|list|password|remove <user>
$ xenopanel cloudflare token add|list|refresh|remove
$ xenopanel cloudflare zone add|status <domain>
$ xenopanel dns status|apply <domain>
$ xenopanel cert issue|status <domain>
$ xenopanel catalog list  # the PHP and MySQL builds it can install

When this Mac manages one server, --server can be left out; with more than one, name it. xenopanel <command> --help lists every option.

Seeing before changing

Every command that changes a server first shows what it will do, with the exact commands it will run there. --dry-run reads the server, shows the plan and stops, changing nothing. --verbose prints the scripts themselves as they run.

Each change runs one step at a time, and each step is checked. A step that fails its check is rolled back. If your Mac loses the connection, the step finishes on the server, and the next run keeps it if it passed its check or rolls it back if it didn’t.

For scripts and AI agents

  • --json prints JSON Lines on stdout, one record per line, errors included. Banners go to stderr.
  • --non-interactive never prompts. A command that needs an answer exits 8 and names the flag that gives it.
  • --confirm <name> answers a confirmation, such as removing a site or changing an existing DNS record.
  • Reading commands such as server status, site list and site status are safe to run at any time; server status doesn’t even contact the server.

Exit codes

Code Meaning
0 Done
3 Something it needs is missing
4 The server can’t be reached
5 A check found something to fix
6 Another run holds the server’s lock
7 Refused, with nothing changed
8 An answer is needed
9 Failed, and the server is as it was
10 Failed after the server changed

Questions about XenoPanel?

Check the help pages first, or send us a message and we’ll get back to you within 24 hours.

Need help with an app or a license? Open a support ticket →

We reply within 24 hours on business days.