@streamr/cli-tools
Advanced tools
Command line tool for interacting with Streamr.
npm install -g @streamr/cli-tools
npm publish --access=public
To get a list of all (sub)commands simply run streamr.
All (sub)commands follow pattern streamr <command>.
Run streamr help <command> or streamr <command> --help to get more information about a a command, its options, and
so forth.
Used to subscribe to a stream and output real-time JSON objects to stdout line-by-line.
For example, to listen to a public stream such as the tram demo do
streamr listen 7wa7APtlTq6EC5iTCBy6dw
To listen to a private stream:
streamr listen streamId apiKey
Flag --dev or --stg can be enabled for the command to operate on pre-defined development or staging environment.
Used to publish events to a stream from stdin line-by-line. Each line should be a valid JSON object.
Example of use:
streamr publish streamId apiKey
Flag --dev or --stg can be enabled for the command to operate on pre-defined development or staging environment.
Generate random JSON objects to stdout line-by-line.
Useful for generating test data to be published to a stream with publish, e.g.:
streamr generate | streamr publish streamId apiKey
Fetch a list of streams that are accessible to the given api key
streamr list apiKey
Show detailed information about a specific stream
streamr show streamId apiKey
Create a new stream
streamr create name apiKey
You can use the piping facilities of your *nix operating system with commands publish and listen to achieve some
useful operations. Below is a list of some ideas.
You can pipe the line-by-line JSON objects output by listen to
your program written in any language. Just make the program read JSON objects
from stdin.
streamr listen 7wa7APtlTq6EC5iTCBy6dw | ruby calculate-average-speed.rb
If your program produces JSON objects to stdout (line-by-line), you can
redirect it to command publish to publish the JSON objects to a stream.
python printSensorReadingsAsJson.py | streamr publish streamId apiKey
You can also listen to a stream, apply a transformation, and then pipe the transformed output into another stream.
streamr listen sourceStream | ./calculateMovingAverages | streamr publish destinationStream apiKey
Same rules apply here as before. Your program should accept line-by-line JSON objects via stdin and output JSON objects to stdout line-by-line.
If you have a working stream in production that you'd also like to use in your
development environment, you can combine the listen and publish commands to effectively copy
the real-time events.
streamr listen 7wa7APtlTq6EC5iTCBy6dw | streamr publish --dev streamId apiKey
And the same for staging environment:
streamr listen 7wa7APtlTq6EC5iTCBy6dw | streamr publish --stg streamId apiKey
This CLI tool is basically a thin wrapper around streamr-client-javascript, which does all the heavy lifting.
The code of this tool concentrates more on the CLI concerns: parsing and passing arguments, stdin/stdout, errors, and so forth.
See issues, especially those tagged with "help wanted". We welcome pull requests and issues.
[102.0.0] - 2025-01-27
PUBLISH and SUBSCRIBE permissionsStreamrClient#getUserId() methodStreamrClient#getDiagnosticInfo() provides diagnostic info about network (https://github.com/streamr-dev/network/pull/2740, https://github.com/streamr-dev/network/pull/2741)Stream#getPartitionCount()Stream#getDescription() and Stream#setDescription()Stream#getStorageDayCount() and Stream#setStorageDayCount()StreamrClient#getStreamMetadata() (https://github.com/streamr-dev/network/pull/2883)opts parameter to StreamrClient#addStreamToStorageNode (https://github.com/streamr-dev/network/pull/2858)
user to userId in these interfaces: (https://github.com/streamr-dev/network/pull/2811)
UserPermissionAssignment
grantPermissions(), revokePermissions(), getPermissions() and setPermissions()UserPermissionQuery
hasPermission()SearchStreamsPermissionFilter
searchStreams()StreamMetadata is Record<string, unknown> (https://github.com/streamr-dev/network/pull/2825, https://github.com/streamr-dev/network/pull/2845)
Stream#addToStorageNode() doesn't wait for acknowledgment by default (https://github.com/streamr-dev/network/pull/2810)StreamrClient#updateStream() and Stream#update(): (https://github.com/streamr-dev/network/pull/2826, https://github.com/streamr-dev/network/pull/2855, https://github.com/streamr-dev/network/pull/2859, https://github.com/streamr-dev/network/pull/2862)
StreamrClient#setStreamMetadata() and Stream#setMetadata() insteadStream#getMetadata() and Stream#getStreamParts() are async (https://github.com/streamr-dev/network/pull/2883)streamRemovedFromFromStorageNode to streamRemovedFromStorageNode (https://github.com/streamr-dev/network/pull/2930)StreamrClientError: (https://github.com/streamr-dev/network/pull/2895, https://github.com/streamr-dev/network/pull/2927)
StreamrClientError contains MessageID instead of StreamMessageStreamRegistry from v4 to v5 (https://github.com/streamr-dev/network/pull/2780)StreamPartitionInfo format changed (https://github.com/streamr-dev/network/pull/2738, https://github.com/streamr-dev/network/pull/2790)Stream#detectFields() method (https://github.com/streamr-dev/network/pull/2864)Stream#delete() method (https://github.com/streamr-dev/network/pull/2863)
StreamrClient#deleteStream() insteadStreamrClient#findOperators() method (https://github.com/streamr-dev/network/pull/2876)network.node.id (https://github.com/streamr-dev/network/pull/2777)network.controlLayer.webNewrtcConnectionTimeout (https://github.com/streamr-dev/network/pull/2776)Operator#getExpiredFlags() (https://github.com/streamr-dev/network/pull/2739)environment config option now applies additional settings if dev2 value is used (https://github.com/streamr-dev/network/pull/2813)
entryPointDiscovery and metricsbin/config-wizard script (i.e. the streamr-broker-init command) (https://github.com/streamr-dev/network/pull/2830)
streamr-node-init command insteadstreamr-broker (https://github.com/streamr-dev/network/pull/2881)
streamr-node command insteadstreamr stream publish (https://github.com/streamr-dev/network/pull/2947)streamr stream susbcribe (https://github.com/streamr-dev/network/pull/2948)streamr mock-data generate command (https://github.com/streamr-dev/network/pull/2946)--dev flag with --env flag (https://github.com/streamr-dev/network/pull/2817, https://github.com/streamr-dev/network/pull/2834)
--env flag supports multiple environmentsenvironment in a config file, this overrides it--env dev2 for the development environmentFAQs
Command line tools for Streamr
The npm package @streamr/cli-tools receives a total of 85 weekly downloads. As such, @streamr/cli-tools popularity was classified as not popular.
We found that @streamr/cli-tools demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Newly introduced telemetry in devenv 1.4 sparked a backlash over privacy concerns, leading to the removal of its AI-powered feature after strong community pushback.
Security News
TC39 met in Seattle and advanced 9 JavaScript proposals, including three to Stage 4, introducing new features and enhancements for a future ECMAScript release.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.