Appearance
CLI
plexctl is the operator-facing command-line client for the plexsphere /v1 REST API. It ships from cmd/plexctl/ as a single static Go binary and shares the typed OpenAPI client with the dashboard, so a CLI flag and a dashboard click hit the same backend handler.
What is here
plexctl— top-level reference — global flags, authentication profile model, exit-code taxonomy.- Per-command references under
plexctl/— one page each foraction,alert,audit,backup,blueprint,bootstrap-token,cloud,completion,credential,domain,domain-idp,exec-log,group,identity,identity-tokens,key,kubeconfig,label,login,logs,mesh,metrics,peer,project,rebac,resource,restore,secret,ssh,state,support-bundle,tcp-forward, andwhoami.
When to read this section
- You need the canonical syntax for a
plexctlcommand, including flag types and exit codes. - You are scripting
plexctlagainst the API and need to know which exit codes are stable and what they mean. - You are debugging a
plexctlfailure and want to confirm the expected output shape.
For the high-level operator workflows that compose multiple plexctl commands, see the CLI how-to guides and the operating procedures.