https://github.com/s2-streamstore/s2-cli
CLI for S2
https://github.com/s2-streamstore/s2-cli
cli rust s2
Last synced: about 1 month ago
JSON representation
CLI for S2
- Host: GitHub
- URL: https://github.com/s2-streamstore/s2-cli
- Owner: s2-streamstore
- License: apache-2.0
- Created: 2024-09-17T16:36:04.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-03-17T12:29:38.000Z (2 months ago)
- Last Synced: 2025-03-17T12:50:24.022Z (2 months ago)
- Topics: cli, rust, s2
- Language: Rust
- Homepage: https://s2.dev
- Size: 307 KB
- Stars: 18
- Watchers: 1
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
S2 CLI
Command Line Tool to interact with the
[S2 API](https://s2.dev/docs/interface/grpc).
## 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
```
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 streamstore-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 [[email protected]](mailto:[email protected]).
## License
This project is licensed under the [Apache-2.0 License](./LICENSE).