Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/strmprivacy/cli
This is the STRM Privacy Command Line Interface, to define and manage your privacy streams, data schemas, event contracts and much more.
https://github.com/strmprivacy/cli
cli data data-pipeline data-privacy data-privacy-compliance data-processing privacy
Last synced: 6 days ago
JSON representation
This is the STRM Privacy Command Line Interface, to define and manage your privacy streams, data schemas, event contracts and much more.
- Host: GitHub
- URL: https://github.com/strmprivacy/cli
- Owner: strmprivacy
- License: apache-2.0
- Created: 2021-01-18T16:18:03.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-08-03T14:08:58.000Z (over 1 year ago)
- Last Synced: 2023-08-03T14:37:49.649Z (over 1 year ago)
- Topics: cli, data, data-pipeline, data-privacy, data-privacy-compliance, data-processing, privacy
- Language: Go
- Homepage: https://strmprivacy.io
- Size: 1.07 MB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# STRM Privacy Command Line Interface
[](https://github.com/strmprivacy/cli/actions)
[](https://github.com/strmprivacy/cli/releases/latest)
This package contains a command line interface (CLI) for interacting with [STRM Privacy](https://www.strmprivacy.io).
## Installation
### Builds
The STRM CLI is available for major OS platforms: Linux, Mac and Windows. Please note Windows builds are not tested by us, but should work properly.
### Manually
Download the latest release for your platform from
the [releases page](https://github.com/strmprivacy/cli/releases/latest). Put the binary somewhere on your path.
#### Authentication
Authentication is handled through the browser with the `strm auth login` command. If you can't login through browser (e.g. when using the CLI in scripts or on remote machines), a headless auth flow is supported through the `--remote` and `--non-interactive` flags. Note: this requires both a browser-accessible machine to run `--remote` to initiate authentication and the non-browser machine to run `strm auth login --non-interactive`. The help command `strm auth login --help` also provides directions.
#### Shell Completion
In order to set up command completion, please follow the instructions below:
- for `bash` users \
add the following line to your `.bash_profile` or `.bashrc`:
`source <(strm completion bash)`
or, to load completions for each session, execute once:
- Linux users: `strm completion bash > /etc/bash_completion.d/strm`
- macOS users: `strm completion bash > /usr/local/etc/bash_completion.d/strm`
- for `zsh` users \
ensure that shell completion is enabled, then run (only needs to be done once):
`strm completion zsh > "${fpath[1]}/_strm"`
- for fish users \
`strm completion fish > ~/.config/fish/completions/strm.fish` (or `$XDG_CONFIG_HOME` instead of `~/.config`)
### Homebrew
The CLI is also available through Homebrew. Install the formula as follows:
```
brew install strmprivacy/cli/strm
```
Ensure to read the caveats section for setting up command completion.
Upgrades to the CLI can be done through `brew upgrade strm`.
### Other package managers
More package managers will be added in the future, so stay tuned.
## Commands
For the complete command reference, see
the [CLI section in our docs](https://docs.strmprivacy.io/docs/latest/reference/cli-reference/).
## Configuration
The `strm` CLI can be configured using either the flags as specified by the help (as command line arguments), with
environment variables, or with a configuration file, named `config.yaml`, located in the STRM
Privacy [Configuration directory](#configuration-directory). If a flag is not present, the default value is used.
*Note: The ordering is the same as specified above, so arguments take precedence over environment variables, which take
precedence over the configuration file, which takes precedence over the default values.*
| Flag | Description |
| ------------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| save | indicates whether the output of create commands is saved to files in your STRM Privacy [Configuration directory](#configuration-directory). Useful in some situations, but be aware that this is sensitive information |
| events-auth-url | used for retrieving/refreshing (JWT) authentication tokens for sending events (with the `simulate` command) |
| events-api-url | where to send events to (with the `sim` command in the CLI) |
| api-auth-url | used for logging in and retrieving/refreshing ([JWT](https://jwt.io/)) authentication tokens |
| api-host | used for interacting with the API (e.g. managing streams, data connectors, etc) |
| web-socket-url | used to listen to events with the `listen web-socket` command |
### Default configuration values
Below are the default values for all `strm` flags, in the YAML format used by the configuration file:
```yaml
save: false
events-api-url: https://events.strmprivacy.io/event
api-auth-url: https://accounts.strmprivacy.io
api-host: api.strmprivacy.io:443
web-socket-url: wss://websocket.strmprivacy.io/ws
```
In normal circumstances, these defaults should work and there is no need to create this configuration file and override
any Flags. It can be useful in special cases, for example if you'd like to use a mock endpoint for testing.
### Configuration directory
The STRM Privacy CLI stores it's information in a configuration directory, by default located in:
`$HOME/.config/strmprivacy/`. In this directory, the CLI looks for a file named: `config.yaml`, which is used for
setting global flags.
By default, this directory also contains the login information used by the `strm auth` commands, in a file
named: `strm-creds-.json`. This file is generated and updated by the CLI, so there is no need for any
manual editing.
In this directory you can also find all entities that have been `save`d (see the [Save](#configuration) option). These
entities are saved in the following files: `//.json`, where `Entity` is the Entity name,
i.e. "Stream" or "DataConnector" and the `name` is the unique name of the created entity, i.e. "MyImportantStream" or
"s3-data-connector".
## Getting help
If you encounter an error, or you'd like a new feature, please create an
issue [here](https://github.com/strmprivacy/cli/issues/new). Please be thorough in your description, as it helps us
to help you more quickly. At least include the version of the CLI, your OS. terminal and any custom STRM Privacy flags
that are present in your config or environment.
***IMPORTANT: Don't provide the login configuration JSON file, as it includes sensitive information!***
[Email Developer Support](mailto:[email protected]), with the details of the issue you’re experiencing. A
minimum working example (MWE) would help us in reproducing the issue, and could help in solving it sooner for you. If
you have to option to include an MWE, please do so.
## More resources
See our [documentation](https://docs.strmprivacy.io)
or [reach out to us](https://docs.strmprivacy.io/docs/latest/contact/index.html).