streamr-filetransfer-cli
v0.0.2
Published
Streamr filetransfer CLI
Downloads
6
Maintainers
Readme
streamr-file-transfer-cli
Streamr file transfer command line interface. Transfer files over Streamr network.
Usage
$ 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 receive [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
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 <value> -s <value> -p <value> [-w <value>]
ARGUMENTS
FILEPATH Folder path
FLAGS
-k, --privatekey=<value> (required) Private key
-p, --filepath=<value> (required) Folder path
-s, --stream=<value> (required) Stream ID
-w, --wait=<value> 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<FOLDER> -k<0xPRIVATEKEY> -s<STREAM_ID>
See code: dist/commands/receive/index.ts
streamr-filetransfer-cli send FILEPATH
Streamr file transfer send command.
USAGE
$ streamr-filetransfer-cli send FILEPATH -k <value> -s <value> [-b <value>] [-w <value>]
ARGUMENTS
FILEPATH Filepath
FLAGS
-b, --bytesPerSlice=<value> Chunk size in KB
-k, --privatekey=<value> (required) Private key
-s, --stream=<value> (required) Stream ID
-w, --wait=<value> Wait time between sending chunks in milliseconds
DESCRIPTION
Streamr file transfer send command.
EXAMPLES
$ streamr-filetransfer-cli send <FILE_PATH> -k<0xPRIVATEKEY> -s<STREAM_ID>
See code: dist/commands/send/index.ts