Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.paubox.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Requirements

  • Node.js ≥ 20.12.0. Download at nodejs.org or install via your preferred version manager (nvm, fnm, etc.).
  • Linux only: Install libsecret-1-dev before running the CLI if you want OS keychain support. See Linux: keychain support below.

​
Install

npm install -g paubox-cli

​
Verify the installation

paubox --version
You should see output like 0.1.3. If the command is not found, ensure your global npm bin directory is on your PATH.

​
Linux: keychain support

The Paubox CLI stores credentials in the OS keychain by default. On Linux, this requires the Secret Service API, which is provided by GNOME Keyring or KWallet. The underlying keytar library needs libsecret-1-dev at install time. On Debian/Ubuntu: 
sudo apt install libsecret-1-dev
npm install -g paubox-cli
On Fedora/RHEL: 
sudo dnf install libsecret-devel
npm install -g paubox-cli
Fallback behavior: If libsecret is not available, credentials are stored in ~/.config/paubox/config.json with 0600 permissions (readable only by your user). The CLI will warn you when it falls back to file-based storage.
If you share a machine or use file-based credential storage, ensure ~/.config/paubox/config.json is excluded from any backups or source control.