An open-source CLI for managing ZebraStream accounts.
Project description
ZebraStream CLI
An open-source command-line interface for the Management API of ZebraStream, a simple, managed service to establish data flow between organizations, applications, and devices. Easily manage access tokens and view usage statistics for your ZebraStream account from your terminal.
Features
- Create new access tokens
- List all access tokens
- Delete access tokens
- Show usage statistics
Installation
Recommended: Install Globally with pipx
pipx allows you to run Python CLI tools in isolated environments:
pipx install zebrastream-cli
Install the Latest Stable Release from PyPI
pip install zebrastream-cli
Install the Latest Development Version from GitHub
pip install git+https://github.com/ZebraStream/zebrastream-cli.git
Usage
After installation, the CLI is available as zebrastream-cli:
Authentication
All commands require an API key. You can set it as an environment variable:
export ZEBRASTREAM_API_KEY=your_api_key_here
You can also set the API key persistently:
ZEBRASTREAM_API_KEY=your_api_key_here zebrastream-cli persist-config
Optional: Custom API URL
The default uses the official ZebraStream Management API, but it is also possible to use a custom ZebraStream API endpoint:
export ZEBRASTREAM_API_URL=https://your.custom.api.url
Commands
Create a New Access Token
zebrastream-cli create-token \
--path /mystream \
--access-mode read \
--expires 2027-12-31 \
[--recursive]
--expiresaccepts ISO 8601 format (e.g.2027-12-31or2027-12-31T12:34:56).
List All Access Tokens
zebrastream-cli list-tokens
- Expired tokens are highlighted in red.
Delete an Access Token
zebrastream-cli delete-token --token-id key_xxxxxxxxxxxxxxxx
Show Usage Statistics
zebrastream-cli show-usage [--month YYYY-MM]
Help
To see the available commands use:
zebrastream-cli --help
For detailed help on any command, use:
zebrastream-cli COMMAND --help
License
See LICENSE for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file zebrastream_cli-0.0.1.tar.gz.
File metadata
- Download URL: zebrastream_cli-0.0.1.tar.gz
- Upload date:
- Size: 22.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.1.3 CPython/3.13.1 Linux/6.11.0-1015-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8fc8c58897f6798b12ab3e6e5742ba1738029570ff47fc839ae4e356d91ea471
|
|
| MD5 |
177370cc2c116c6a6f532a1fc887dfea
|
|
| BLAKE2b-256 |
1d1021f07e6516fff64e88f1321424b5052c00cf2b2a1ca7c2e5e970f4dedc95
|
File details
Details for the file zebrastream_cli-0.0.1-py3-none-any.whl.
File metadata
- Download URL: zebrastream_cli-0.0.1-py3-none-any.whl
- Upload date:
- Size: 31.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.1.3 CPython/3.13.1 Linux/6.11.0-1015-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f195cf480b4ed0157bd2bab44f220b82b483c0ae9ce0d21567024edf1c1122a8
|
|
| MD5 |
f8405563d151ac482de78d01ee3b2590
|
|
| BLAKE2b-256 |
ab9fdbfe7006b7e130ae858bc38fc0699f1d8adab89ff6bf56b0b8358c0cf0d4
|