https://github.com/streamr-dev/streamr-filetransfer-cli
Enabling file transfers via CLI through Streamr Network
https://github.com/streamr-dev/streamr-filetransfer-cli
Last synced: 15 days ago
JSON representation
Enabling file transfers via CLI through Streamr Network
- Host: GitHub
- URL: https://github.com/streamr-dev/streamr-filetransfer-cli
- Owner: streamr-dev
- License: mit
- Created: 2023-05-31T11:33:05.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-17T08:02:49.000Z (over 2 years ago)
- Last Synced: 2025-07-10T16:51:13.269Z (8 months ago)
- Language: TypeScript
- Size: 256 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
streamr-file-transfer-cli
=================
Streamr file transfer command line interface. Transfer files over Streamr network.
[](https://opensource.org/licenses/MIT)
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ npm install -g streamr-filetransfer-cli
$ streamr-filetransfer-cli COMMAND
running command...
$ streamr-filetransfer-cli (--version)
streamr-filetransfer-cli/0.0.2 win32-x64 node-v16.20.0
$ streamr-filetransfer-cli --help [COMMAND]
USAGE
$ streamr-filetransfer-cli COMMAND
...
```
# Commands
* [`streamr-filetransfer-cli help [COMMANDS]`](#streamr-filetransfer-cli-help-commands)
* [`streamr-filetransfer-cli receive [FILEPATH]`](#streamr-filetransfer-cli-receive-filepath)
* [`streamr-filetransfer-cli send FILEPATH`](#streamr-filetransfer-cli-send-filepath)
## `streamr-filetransfer-cli help [COMMANDS]`
Display help for streamr-filetransfer-cli.
```
USAGE
$ streamr-filetransfer-cli help [COMMANDS] [-n]
ARGUMENTS
COMMANDS Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for streamr-filetransfer-cli.
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.9/src/commands/help.ts)_
## `streamr-filetransfer-cli receive [FILEPATH]`
Streamr file transfer receive command. To exit receive mode use CTRL+C (win/mac) or Command+C (osx).
```
USAGE
$ streamr-filetransfer-cli receive [FILEPATH] -k -s -p [-w ]
ARGUMENTS
FILEPATH Folder path
FLAGS
-k, --privatekey= (required) Private key
-p, --filepath= (required) Folder path
-s, --stream= (required) Stream ID
-w, --wait= Wait time between receiving chunks in milliseconds
DESCRIPTION
Streamr file transfer receive command. To exit receive mode use CTRL+C (win/mac) or Command+C (osx).
EXAMPLES
$ streamr-filetransfer-cli receive -p -k<0xPRIVATEKEY> -s
```
_See code: [dist/commands/receive/index.ts](https://github.com/streamr-dev/streamr-filetransfer-cli/blob/v0.0.2/dist/commands/receive/index.ts)_
## `streamr-filetransfer-cli send FILEPATH`
Streamr file transfer send command.
```
USAGE
$ streamr-filetransfer-cli send FILEPATH -k -s [-b ] [-w ]
ARGUMENTS
FILEPATH Filepath
FLAGS
-b, --bytesPerSlice= Chunk size in KB
-k, --privatekey= (required) Private key
-s, --stream= (required) Stream ID
-w, --wait= Wait time between sending chunks in milliseconds
DESCRIPTION
Streamr file transfer send command.
EXAMPLES
$ streamr-filetransfer-cli send -k<0xPRIVATEKEY> -s
```
_See code: [dist/commands/send/index.ts](https://github.com/streamr-dev/streamr-filetransfer-cli/blob/v0.0.2/dist/commands/send/index.ts)_