Skip to content

Repository files navigation

pbctl

Pillarbox logo

Quality npm version node license: MIT

pbctl is an interactive terminal interface, built with Ink and inkstand, for the pillarbox-demo-backend REST API. It targets the protected Management API (media, folders, teams, users) and the public Player API.

Quick start

Install with npm (Node 20 or later):

npm install -g @srgssr/pbctl

Or run it once without installing:

npx @srgssr/pbctl

Standalone binaries are also available. The installation script keeps versions side by side and points a current symlink at the active one; run it again to update, or with -v <version> to pin or roll back:

mkdir -p ~/.pbctl && cd ~/.pbctl
wget https://raw.githubusercontent.com/srgssr/pbctl/main/install-pbctl.sh
chmod +x install-pbctl.sh
./install-pbctl.sh
export PATH="$HOME/.pbctl/current:$PATH"

Then start with:

pbctl

On first start, create a profile pointing at your backend and identity provider. See the authentication guide for troubleshooting this step.

Contributing

See the contributing guide. Participation is governed by the Code of Conduct. To report a vulnerability, see the security policy.

License

MIT, see LICENSE.

About

A TUI client for the pillarbox backend

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages