Skip to content

Commit

Permalink
..
Browse files Browse the repository at this point in the history
Signed-off-by: Vaibhav Rabber <[email protected]>
  • Loading branch information
vrongmeal committed Dec 16, 2024
1 parent ea12675 commit cb99de0
Showing 1 changed file with 38 additions and 4 deletions.
42 changes: 38 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,26 +24,60 @@
</p>
</div>

Command Line Tool to interact with the [S2 API](https://buf.build/streamstore/s2/docs/main:s2.v1alpha).
Command Line Tool to interact with the
[S2 API](https://buf.build/streamstore/s2/docs/main:s2.v1alpha).

## Getting started

1. [Install](#installation) the S2 CLI using your preferred method.

1. Generate an authentication token by logging onto the web console at
[s2.dev](https://s2.dev/dashboard) and set the token in CLI config:
```bash
s2 config set --auth-token <YOUR AUTH TOKEN>
```

1. You're ready to run S2 commands!
```bash
s2 list-basins
```

Head over to [S2 Docs](https://s2.dev/docs/quickstart) for a quick dive into
using the CLI.

## Commands and reference

You can add the `--help` flag to any command for CLI reference. Run `s2 --help`
to view all the supported commands and options.

> [!TIP]
> The `--help` command displays a verbose help message whereas the `-h` displays
> the same message in brief.
## Installation

### Using Homebrew

This works on macOS and Linux distributions with [Homebrew](https://brew.sh)
installed.
This method works on macOS and Linux distributions with
[Homebrew](https://brew.sh) installed.

```bash
brew install s2-streamstore/s2/s2
```

### Using Cargo

This method works on any system with [Rust](https://www.rust-lang.org/)
and [Cargo](https://doc.rust-lang.org/cargo/) installed.

```bash
cargo install streamstore-cli
```

## Getting started
### From Release Binaries

Check out the [S2 CLI Releases](https://github.com/sharkdp/bat/releases) for
prebuilt binaries for many different architectures and operating systems.

## Feedback

Expand Down

0 comments on commit cb99de0

Please sign in to comment.