subspace-cli
v0.1.2
Published
subspace cli
Downloads
4
Readme
subspace-cli
Small subspace cli tool based on @subspace/subspace library
Usage
$ npm install -g subspace-cli
$ subspace-cli COMMAND
running command...
$ subspace-cli (--version)
subspace-cli/0.0.0 darwin-arm64 node-v16.18.0
$ subspace-cli --help [COMMAND]
USAGE
$ subspace-cli COMMAND
...
Commands
subspace-cli storage:get --objectId OBJECT_ID
subspace-cli storage:put --file FILENAME
subspace-cli help [COMMAND]
subspace-cli plugins
subspace-cli plugins:install PLUGIN...
subspace-cli plugins:inspect PLUGIN...
subspace-cli plugins:install PLUGIN...
subspace-cli plugins:link PLUGIN
subspace-cli plugins:uninstall PLUGIN...
subspace-cli plugins:uninstall PLUGIN...
subspace-cli plugins:uninstall PLUGIN...
subspace-cli plugins update
subspace-cli storage:get --objectId OBJECT_ID
Receives an objectId calling findObject to return the Object as Uint8Array.
USAGE
$ subspace-cli storage get [--mnemonic <value>] [--nodeWsProvider <value>] [--farmerWsProvider <value>] [--objectId <value>]
FLAGS
--farmerWsProvider=<value>
--mnemonic=<value>
--nodeWsProvider=<value>
--objectId=<value>
DESCRIPTION
Receives an objectId calling findObject to return the Object as Uint8Array.
EXAMPLES
$ subspace-cli storage get --help
$ subspace-cli storage get --objectId bfdcac2c580955e05913add271639e72ffdb6507b42dfcd16960717727918df8
See code: dist/commands/hello/index.ts
subspace-cli storage:put --file FILENAME
Receives an Object as Uint8Array, it create and submit a signed put transaction and return an objectId.
USAGE
$ subspace-cli storage put [--mnemonic <value>] [--nodeWsProvider <value>] [--farmerWsProvider <value>] [--file <value>]
FLAGS
--farmerWsProvider=<value>
--file=<value>
--mnemonic=<value>
--nodeWsProvider=<value>
DESCRIPTION
Receives an Object as Uint8Array, it create and submit a signed put transaction and return an objectId.
EXAMPLES
$ subspace-cli storage put --help
$ subspace-cli storage put --file ./example.jpeg
subspace-cli help [COMMAND]
Display help for subspace-cli.
USAGE
$ subspace-cli help [COMMAND] [-n]
ARGUMENTS
COMMAND Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for subspace-cli.
See code: @oclif/plugin-help
subspace-cli plugins
List installed plugins.
USAGE
$ subspace-cli plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ subspace-cli plugins
See code: @oclif/plugin-plugins
subspace-cli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ subspace-cli plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ subspace-cli plugins add
EXAMPLES
$ subspace-cli plugins:install myplugin
$ subspace-cli plugins:install https://github.com/someuser/someplugin
$ subspace-cli plugins:install someuser/someplugin
subspace-cli plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ subspace-cli plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ subspace-cli plugins:inspect myplugin
subspace-cli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ subspace-cli plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ subspace-cli plugins add
EXAMPLES
$ subspace-cli plugins:install myplugin
$ subspace-cli plugins:install https://github.com/someuser/someplugin
$ subspace-cli plugins:install someuser/someplugin
subspace-cli plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ subspace-cli plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ subspace-cli plugins:link myplugin
subspace-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ subspace-cli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ subspace-cli plugins unlink
$ subspace-cli plugins remove
subspace-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ subspace-cli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ subspace-cli plugins unlink
$ subspace-cli plugins remove
subspace-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ subspace-cli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ subspace-cli plugins unlink
$ subspace-cli plugins remove
subspace-cli plugins update
Update installed plugins.
USAGE
$ subspace-cli plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.