S2 CLI

Command Line Interface to interact with the [S2 API](https://s2.dev/docs/rest/protocol). ## Getting started 1. [Install](#installation) the S2 CLI using your preferred method. 1. Generate an access token by logging into the web console at [s2.dev](https://s2.dev/dashboard) and set the token in CLI config: ```bash s2 config set access_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 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 --locked s2-cli ``` ### From Release Binaries Check out the [S2 CLI Releases](https://github.com/s2-streamstore/s2-cli/releases) for prebuilt binaries for many different architectures and operating systems. Linux and macOS users can download the release binary using: ```bash curl -fsSL s2.dev/install.sh | bash ``` To install a specific version, you can set the `VERSION` environment variable. ```bash export VERSION=0.5.2 curl -fsSL s2.dev/install.sh | bash ``` ## Feedback We use [Github Issues](https://github.com/s2-streamstore/s2-cli/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](https://discord.gg/vTCs7kMkAf) server. We would love to hear from you. You can also email us at [hi@s2.dev](mailto:hi@s2.dev). ## License This project is licensed under the [MIT License](./LICENSE).

Statistics

Topics

Details

Quality Indicators