Connecting to a Server

pb stores server connections as named profiles. Each profile keeps the server URL and authentication details for one Parseable instance. If you work with more than one environment, such as staging and production, profiles let you switch between them without re-entering credentials each time.

Interactive login (recommended)

Run pb login to start the interactive setup. Choose self-hosted Parseable or Parseable Cloud, then pick the authentication method that fits that server.

pb login

For self-hosted Parseable, enter the server URL and sign in with either a username and password or an API key. For Parseable Cloud, sign in in the browser or provide a Parseable Cloud API key. The selected Cloud workspace is then saved into the profile.

When the flow finishes, that profile becomes the active default.

Non-interactive login

For scripts and CI pipelines, use pb profile add when you want to create a profile without prompts:

pb profile add <name> <url> <username> <password>

pb profile add production https://logs.mycompany.com admin s3cr3t

Use a self-hosted API key instead of username and password:

pb profile add production-key https://logs.mycompany.com --api-key psk_xxx

Add a Parseable Cloud API-key profile:

pb cloud profile add --name production-cloud --api-key psk_xxx

You can also omit credentials and let pb prompt for them:

pb profile add production https://logs.mycompany.com

Managing profiles

Once you have more than one profile, these are the commands you will use most often:

pb profile list
pb profile default staging

To update or remove a saved profile:

pb profile update production https://new-url.mycompany.com
pb profile set-url production https://new-url.mycompany.com
pb profile remove old-staging
pb profile rm old-staging

Check connection status

pb status

This checks whether the active profile can reach the server and shows basic server details when they are available:

Profile : production
URL     : https://logs.mycompany.com
User    : admin
Status  : Connected  (server v1.4.2)

Logout

pb logout

pb logout removes the active profile from the local config. If you want to log out of a different profile, switch to it first with pb profile default <name>, then run pb logout.

If you want to remove a specific saved profile directly, use:

pb profile remove <name>
pb profile rm <name>

Config file location

Profiles are stored in a TOML config file on disk: