@super-protocol/sp-cli
v0.0.9
Published
SuperProtocol Command line interface
Maintainers
Keywords
Readme
sp-cli
=================
SuperProtocol Command line interface
Usage
$ npm install -g @super-protocol/sp-cli
$ sp COMMAND
running command...
$ sp (--version)
@super-protocol/sp-cli/0.0.9 linux-x64 node-v22.22.0
$ sp --help [COMMAND]
USAGE
$ sp COMMAND
...Commands
sp account forgetsp account get-sppisp account infosp account listsp account loginsp account switchsp autocomplete [SHELL]sp files download RESOURCEFILE LOCALDIRECTORYsp files upload PATHsp help [COMMAND]sp loginsp storage createsp storage selectsp storage showsp storage updatesp workflows extend-lease ORDERID
sp account forget
Purge all account details
USAGE
$ sp account forget [--json] [--tty] [-f] [-n <value>]
FLAGS
-f, --force Force forget without confirmation
-n, --name=<value> Account name to forget
GLOBAL FLAGS
--json Format output as json.
--[no-]tty Force or disable interactive mode (use --no-tty to disable).
DESCRIPTION
Purge all account details
EXAMPLES
$ sp account forget
$ sp account forget --name "My Account"
$ sp account forget --name "My Account" --forceSee code: src/commands/account/forget.ts
sp account get-sppi
Get SPPI (Super Protocol incentive tokens)
USAGE
$ sp account get-sppi [--json] [--tty]
GLOBAL FLAGS
--json Format output as json.
--[no-]tty Force or disable interactive mode (use --no-tty to disable).
DESCRIPTION
Get SPPI (Super Protocol incentive tokens)
EXAMPLES
$ sp account get-sppiSee code: src/commands/account/get-sppi.ts
sp account info
Information about current authorized user
USAGE
$ sp account info [--json] [--tty] [--detail]
FLAGS
--detail Detailed information about Account
GLOBAL FLAGS
--json Format output as json.
--[no-]tty Force or disable interactive mode (use --no-tty to disable).
DESCRIPTION
Information about current authorized userSee code: src/commands/account/info.ts
sp account list
List all Accounts
USAGE
$ sp account list [--json] [--tty]
GLOBAL FLAGS
--json Format output as json.
--[no-]tty Force or disable interactive mode (use --no-tty to disable).
DESCRIPTION
List all Accounts
EXAMPLES
$ sp account listSee code: src/commands/account/list.ts
sp account login
Login to SuperProtocol (sign up or sign in).
USAGE
$ sp account login [--json] [--tty] [--name <value>] [--privateKey <value>] [--path <value>] [-y]
FLAGS
-y, --yes Skip questions (generate keys when needed).
--name=<value> Account readable name
--path=<value> Path to account(configuration) file to import
--privateKey=<value> Account private key used for authentication
GLOBAL FLAGS
--json Format output as json.
--[no-]tty Force or disable interactive mode (use --no-tty to disable).
DESCRIPTION
Login to SuperProtocol (sign up or sign in).
ALIASES
$ sp login
EXAMPLES
$ sp account loginSee code: src/commands/account/login.ts
sp account switch
Switch to a different account
USAGE
$ sp account switch [--json] [--tty] [-n <value>]
FLAGS
-n, --name=<value> Account name to switch
GLOBAL FLAGS
--json Format output as json.
--[no-]tty Force or disable interactive mode (use --no-tty to disable).
DESCRIPTION
Switch to a different account
EXAMPLES
$ sp account switchSee code: src/commands/account/switch.ts
sp autocomplete [SHELL]
Display autocomplete installation instructions.
USAGE
$ sp autocomplete [SHELL] [-r]
ARGUMENTS
[SHELL] (zsh|bash|powershell) Shell type
FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
DESCRIPTION
Display autocomplete installation instructions.
EXAMPLES
$ sp autocomplete
$ sp autocomplete bash
$ sp autocomplete zsh
$ sp autocomplete powershell
$ sp autocomplete --refresh-cacheSee code: @oclif/plugin-autocomplete
sp files download RESOURCEFILE LOCALDIRECTORY
Download file or directory described in resource file
USAGE
$ sp files download RESOURCEFILE LOCALDIRECTORY [--json] [--tty] [--maximum-concurrent <value>]
ARGUMENTS
RESOURCEFILE Path to a resource file
LOCALDIRECTORY Path to save downloaded file
FLAGS
--maximum-concurrent=<value> [default: 1] Maximum concurrent pieces to download at once per transfer
GLOBAL FLAGS
--json Format output as json.
--[no-]tty Force or disable interactive mode (use --no-tty to disable).
DESCRIPTION
Download file or directory described in resource file
EXAMPLES
$ sp files download ./resource.json ./pathToDownloadSee code: src/commands/files/download.ts
sp files upload PATH
Upload file or directory to remote storage
USAGE
$ sp files upload PATH [--json] [--tty] [--filename <value>] [--maximum-concurrent <value>] [--metadata <value>]
[--output <value>] [--skip-encryption] [--sync]
ARGUMENTS
PATH file or directory to upload
FLAGS
--filename=<value> The name of the resulting file/directory in the storage
--maximum-concurrent=<value> [default: 1] Maximum concurrent pieces to upload at once per transfer
--metadata=<value> Path to a metadata file for adding fields to the resource file
--output=<value> [default: resource.json] Path to save resource file that is used to access the uploaded
file
--skip-encryption Skip file encryption before upload
--sync Sync mode: delete files in target that don't exist in source
GLOBAL FLAGS
--json Format output as json.
--[no-]tty Force or disable interactive mode (use --no-tty to disable).
DESCRIPTION
Upload file or directory to remote storage
EXAMPLES
$ sp files upload ./file.txtSee code: src/commands/files/upload.ts
sp help [COMMAND]
Display help for sp.
USAGE
$ sp 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 sp.See code: @oclif/plugin-help
sp login
Login to SuperProtocol (sign up or sign in).
USAGE
$ sp login [--json] [--tty] [--name <value>] [--privateKey <value>] [--path <value>] [-y]
FLAGS
-y, --yes Skip questions (generate keys when needed).
--name=<value> Account readable name
--path=<value> Path to account(configuration) file to import
--privateKey=<value> Account private key used for authentication
GLOBAL FLAGS
--json Format output as json.
--[no-]tty Force or disable interactive mode (use --no-tty to disable).
DESCRIPTION
Login to SuperProtocol (sign up or sign in).
ALIASES
$ sp login
EXAMPLES
$ sp loginsp storage create
Create a new storage entry from file or interactive prompts.
USAGE
$ sp storage create [--json] [--tty] [-f <value>] [--notDefault]
FLAGS
-f, --fromFile=<value> Path to a JSON file that contains AddStorageDto payload.
--notDefault Skip setting the created storage as default.
GLOBAL FLAGS
--json Format output as json.
--[no-]tty Force or disable interactive mode (use --no-tty to disable).
DESCRIPTION
Create a new storage entry from file or interactive prompts.
EXAMPLES
$ sp storage create
$ sp storage create --fromFile ./storage.json
$ sp storage create --not-defaultSee code: src/commands/storage/create.ts
sp storage select
Select a storage that will be used by subsequent commands.
USAGE
$ sp storage select [--json] [--tty]
GLOBAL FLAGS
--json Format output as json.
--[no-]tty Force or disable interactive mode (use --no-tty to disable).
DESCRIPTION
Select a storage that will be used by subsequent commands.
EXAMPLES
$ sp storage selectSee code: src/commands/storage/select.ts
sp storage show
Show current selected storage
USAGE
$ sp storage show [--json] [--tty]
GLOBAL FLAGS
--json Format output as json.
--[no-]tty Force or disable interactive mode (use --no-tty to disable).
DESCRIPTION
Show current selected storage
EXAMPLES
$ sp storage showSee code: src/commands/storage/show.ts
sp storage update
Update the configuration of an existing storage.
USAGE
$ sp storage update [--json] [--tty] [-f <value>] [-i <value>]
FLAGS
-f, --fromFile=<value> Path to a JSON file that contains UpdateStorageDto payload.
-i, --id=<value> Storage ID to update
GLOBAL FLAGS
--json Format output as json.
--[no-]tty Force or disable interactive mode (use --no-tty to disable).
DESCRIPTION
Update the configuration of an existing storage.
EXAMPLES
$ sp storage update --id=2de3e3a4-0000-1111-2222-333344445555 --fromFile ./storage-update.json
$ sp storage update --id=2de3e3a4-0000-1111-2222-333344445555See code: src/commands/storage/update.ts
sp workflows extend-lease ORDERID
Replenish deposit for a workflow to extend its lease time
USAGE
$ sp workflows extend-lease ORDERID [--json] [--tty] [--minutes <value>] [--sppi <value>] [-y]
ARGUMENTS
ORDERID Order ID
FLAGS
-y, --yes Skip confirmation prompt
--minutes=<value> Time to extend order in minutes (automatically calculates tokens)
--sppi=<value> SPPI token amount to add to the order
GLOBAL FLAGS
--json Format output as json.
--[no-]tty Force or disable interactive mode (use --no-tty to disable).
DESCRIPTION
Replenish deposit for a workflow to extend its lease time
EXAMPLES
$ sp workflows extend-lease <orderId> --sppi 1.5
$ sp workflows extend-lease <orderId> --minutes 120
$ sp workflows extend-lease <orderId> --sppi 2 --yesSee code: src/commands/workflows/extend-lease.ts
