@streamr/cli-tools
Advanced tools
Command line tool for interacting with Streamr.
npm install -g @streamr/cli-tools
npm publish --access=public
listen-to-stream and listen-to-stream-devCommands listen-to-stream and listen-to-stream-dev are used to subscribe to
a stream and output real-time JSON objects to stdout line-by-line.
To listen to a public stream such as the Public transport demo:
listen-to-stream 7wa7APtlTq6EC5iTCBy6dw
To listen to a private stream:
listen-to-stream streamId apiKey
where apiKey is the key of the user or stream with READ privilege.
Listen to a development environment stream
listen-to-stream streamId apiKey ws://localhost:8890/api/v1/ws http://localhost:8081/streamr-core/api/v1
or shorthand (when running streamr-docker-dev environment)
listen-to-stream-dev streamId apiKey
publish-to-stream and publish-to-stream-devCommands publish-to-stream and publish-to-stream-dev are used to publish
events to a stream from stdin line-by-line. Each line should be a valid JSON
object.
To publish to a stream:
publish-to-stream streamId apiKey
where apiKey is the key of the user or stream with WRITE privilege.
To publish to a development environment stream:
publish-to-stream streamId apiKey ws://localhost:8890/api/v1/ws http://localhost:8081/streamr-core/api/v1
or shorthand (when running streamr-docker-dev environment)
publish-to-stream-dev streamId apiKey
generate-random-jsonGenerate random JSON objects to stdout line-by-line with
generate-random-json
Useful for testing purposes when piped into publish-to-stream.
publish-to-stream and listen-to-streamDisclaimer: These need more testing
You can use the piping facilities of your *nix operating system with commands
publish-to-stream and listen-to-stream to achieve some interesting results.
Below are listed some example use cases.
You can pipe the line-by-line JSON objects output by listen-to-stream to
your program written in any language. Just make the program read JSON objects
from stdin.
E.g.
listen-to-stream 7wa7APtlTq6EC5iTCBy6dw | ruby calculate-average-speed.rb
If your program produces JSON objects to stdout (line-by-line), you can
redirect it to publish-to-stream to publish the JSON objects to a stream.
E.g.
python printSensorReadingsAsJson.py | publish-to-stream streamId apiKey
You can also listen to a stream, apply a transformation, and then pipe the transformed output into another stream.
E.g.
listen-to-stream sourceStream | ./calculateMovingAverages | publish-to-stream 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 two commands to effectively copy the real-time events.
E.g.
listen-to-stream 7wa7APtlTq6EC5iTCBy6dw | publish-to-stream-dev streamId apiKey
You can also do the reverse:
listen-to-stream-dev devStreamId | publish-to-stream productionStreamId 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.
[101.1.1] - 2024-08-29
FAQs
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.