pb is the command line interface for Parseable Server. pb allows you to manage Streams, Users, and Data on Parseable Server. You can use pb to manage multiple Parseable Server instances using Profiles.

We believe dashboard fatigue is one of key reasons for poor adoption of logging tools among developers. With pb, we intend to bring the familiar command line interface for querying and analyzing log data at scale.

pb is available as a single, self contained binary for Mac, Linux, and Windows. You can download the latest version from the releases page.

To install pb, download the binary for your platform and place it in your $PATH. For example, on Linux:

wget https://github.com/parseablehq/pb/releases/download/v0.1.0/pb_linux_amd64 -O pb
chmod +x pb && mv pb /usr/local/bin

pb comes configured with demo profile as the default. This means you can directly start using pb against the demo Parseable Server. For example, to query the stream backend on demo server, run:

pb query backend

To start using pb against your Parseable server, you need to create a profile (a profile is a set of credentials for a Parseable Server instance). You can create a profile using the pb profile create command. For example:

pb profile add local http://localhost:8000 admin admin

This will create a profile named local that points to the Parseable Server at http://localhost:8000 and uses the username admin and password admin.

You can create as many profiles as you like. To avoid having to specify the profile name every time you run a command, pb allows setting a default profile. To set the default profile, use the pb profile default command. For example:

pb profile default local

To query a stream, run:

pb query <stream-name>

Once a profile is configured, you can use pb to query and manage that Parseable Server instance. For example, to list all the streams on the server, run:

pb stream list

To list all the users with their privileges, run:

pb user list

You can also use the pb users command to manage users.

Version command prints the version of pb and the Parseable Server it is configured to use.

pb version

To get help on a command, run:

pb help <command>