Skip to main content

​
Usage

capsule auth
Capsule will prompt you to paste your license key interactively. The key is never passed as a command-line argument to keep it out of your shell history.

​
What it does

  • Prompts for your license key (starts with cpsl_live_)
  • Validates the key against the Capsule API
  • Saves it to the local config file at ~/.config/capsule/config.json
  • Links this server to your Capsule account

​
Where to find your license key

Your license key is on the Setup page in your dashboard.
Keep your license key secret. Anyone with access to it can link a server to your account.

​
Notes

  • You only need to run capsule auth once per server
  • Re-running it will overwrite the saved key
  • capsule auth does not require an existing key — it is exempt from the authentication check so you can always run it on a fresh install
  • The key is stored in plaintext in the config file — ensure the file has appropriate permissions (chmod 600)