Skip to content

Commit

Permalink
Readme cleanup and add screenshots (#18)
Browse files Browse the repository at this point in the history
  • Loading branch information
nitisht authored Aug 27, 2023
1 parent 1f68708 commit 6cbcba0
Showing 1 changed file with 62 additions and 9 deletions.
71 changes: 62 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,96 @@
## pb

pb (short for Parseable) is a command line interface for [Parseable Server](https://github.com/parseablehq/parseable). pb allows you to manage Streams, Users, and Data on Parseable Server. You can use pb to manage multiple Parseable Server instances using Profiles.
pb is the command line interface for [Parseable Server](https://github.com/parseablehq/parseable). 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 banner](https://github.com/parseablehq/.github/blob/main/images/pb/pb.png?raw=true)

### Installation

pb is available as a single, self contained binary for Mac, Linux, and Windows. You can download the latest version from the [releases page](https://github.com/parseablehq/pb/releases/latest).

To install pb, download the binary for your platform and place it in a directory that is in your $PATH. For example, on Mac you can place the binary in `/usr/local/bin`.
To install pb, download the binary for your platform and place it in your `$PATH`. For example, on Linux:

![pb query](https://github.com/parseablehq/.github/blob/main/images/pb.png?raw=true)
```bash
wget https://github.com/parseablehq/pb/releases/download/v0.1.0/pb_linux_amd64 -O pb
chmod +x pb && mv pb /usr/local/bin
```

### Usage

To get started, `pb` needs at least one 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 comes configured with `demo` profile as the default. This means you can directly start using pb against the [demo Parseable Server](https://demo.parseable.io). For example, to query the stream `backend` on demo server, run:

```bash
pb profile add demo https://demo.parseable.io admin admin
pb query backend
```

This will create a profile named `demo` that points to the Parseable Server instance at `https://demo.parseable.io` 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:
#### Profiles

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:

```bash
pb profile default demo
pb profile add local http://localhost:8000 admin admin
```

Now you can use `pb` to query and manage your Parseable Server instance. For example, to list all the streams on the server, run:
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:

```bash
pb stream list
pb profile default local
```

![pb profiles](https://github.com/parseablehq/.github/blob/main/images/pb/profile.png?raw=true)

#### Query

To query a stream, run:

```bash
pb query <stream-name>
```

![pb query](https://github.com/parseablehq/.github/blob/main/images/pb/query.png?raw=true)

#### Streams

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:

```bash
pb stream list
```

![pb streams](https://github.com/parseablehq/.github/blob/main/images/pb/stream.png?raw=true)

#### Users

To list all the users with their privileges, run:

```bash
pb user list
```

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

![pb users](https://github.com/parseablehq/.github/blob/main/images/pb/user.png?raw=true)

#### Version

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

```bash
pb version
```

![pb version](https://github.com/parseablehq/.github/blob/main/images/pb/version.png?raw=true)

#### Help

To get help on a command, run:

```bash
pb help <command>
```

![pb help](https://github.com/parseablehq/.github/blob/main/images/pb/help.png?raw=true)

0 comments on commit 6cbcba0

Please sign in to comment.