S2 CLI

Command Line Tool to interact with the S2 API.

Getting started

1. Install the S2 CLI using your preferred method.

2. Generate an authentication token by logging onto the web console at s2.dev and set the token in CLI config:

   s2 config set --auth-token <YOUR AUTH TOKEN>

3. You're ready to run S2 commands!

   s2 list-basins

Head over to S2 Docs 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 method works on macOS and Linux distributions with Homebrew installed.

brew install s2-streamstore/s2/s2

Using Cargo

This method works on any system with Rust and Cargo installed.

cargo install streamstore-cli

From Release Binaries

Check out the S2 CLI Releases for prebuilt binaries for many different architectures and operating systems.

Linux and macOS users can download the release binary using:

curl -fsSL s2.dev/install.sh | bash

To install a specific version, you can set the VERSION environment variable.

export VERSION=0.5.2
curl -fsSL s2.dev/install.sh | bash

Feedback

We use Github Issues to track feature requests and issues with the SDK. If you wish to provide feedback, report a bug or request a feature, feel free to open a Github issue.

Contributing

Developers are welcome to submit Pull Requests on the repository. If there is no tracking issue for the bug or feature request corresponding to the PR, we encourage you to open one for discussion before submitting the PR.

Reach out to us

Join our Discord server. We would love to hear from you.

You can also email us at [email protected].

License

This project is licensed under the Apache-2.0 License.