plexsphere

Appearance

Install plexctl ​

plexctl is the operator client for the plexsphere /v1 API. It is distributed as a build artefact; clone the repository and run the Makefile target.

Prerequisites ​

  • A Go toolchain matching /.go-version (Go 1.26). See ../../contributing/toolchain.md.
  • make and git on $PATH.
  • A directory on $PATH for the binary (~/.local/bin, /usr/local/bin, …).

Steps ​

Build the binary ​

shell
git clone https://github.com/plexsphere/plexsphere.git
cd plexsphere
make plexctl-build

make plexctl-build compiles cmd/plexctl/ into bin/plexctl and stamps the build metadata. Building with a bare go build produces an unstamped 0.0.0-dev binary that is not suitable for incident reports — always use the Makefile target.

Install onto $PATH ​

shell
install -m 0755 bin/plexctl ~/.local/bin/plexctl   # user-local
sudo install -m 0755 bin/plexctl /usr/local/bin/plexctl   # system-wide

Enable shell completion ​

shell
plexctl completion bash | sudo tee /etc/bash_completion.d/plexctl >/dev/null

Replace bash with zsh, fish, or powershell as needed; see ../../reference/cli/plexctl/completion.md for the per-shell install path.

Verification ​

shell
plexctl --version
# version=<semver> commit=<sha> date=<rfc3339>

A version=0.0.0-dev line means the binary was built without the Makefile ldflags — rebuild with make plexctl-build.

See also ​