@super-protocol/sp-cli
v0.0.10-beta
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.10-beta 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 assets createsp assets deletesp assets getsp assets listsp assets updatesp autocomplete [SHELL]sp help [COMMAND]sp login
sp account forget
Account management
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
Account management
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
Account management
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
Account management
Get SPPI (Super Protocol incentive tokens)
EXAMPLES
$ sp account get-sppiSee code: src/commands/account/get-sppi.ts
sp account info
Account management
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
Account management
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 and account creation for SuperProtocol
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 and account creation for SuperProtocol
Login to SuperProtocol (sign up or sign in).
ALIASES
$ sp login
EXAMPLES
$ sp account loginSee code: src/commands/account/login.ts
sp account switch
Account management
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
Account management
Switch to a different account
EXAMPLES
$ sp account switchSee code: src/commands/account/switch.ts
sp assets create
Asset management
USAGE
$ sp assets create [--json] [--tty] [-f <value>] [-n <value>] [-t data|image|output] [-s
storj|s3|dockerhub|github|google-docs] [--tag <value>] [--hash <value>] [--size <value>] [--storjBucket <value>]
[--storjPath <value>] [--storjToken <value>] [--s3Bucket <value>] [--s3Path <value>] [--s3AccessKey <value>]
[--s3SecretKey <value>] [--s3Region <value>] [--s3Endpoint <value>] [--dockerImage <value>] [--dockerRegistry
<value>] [--dockerUsername <value>] [--dockerPassword <value>] [--githubRepo <value>] [--githubToken <value>]
[--githubBranch <value>] [--gdocsDocumentId <value>] [--gdocsApiKey <value>] [--gdocsServiceAccountJson <value>]
FLAGS
-f, --fromFile=<value> Path to a JSON file that contains asset definition.
-n, --name=<value> Asset name
-s, --sourceType=<option> Source type
<options: storj|s3|dockerhub|github|google-docs>
-t, --type=<option> Asset type
<options: data|image|output>
--dockerImage=<value> Docker image
--dockerPassword=<value> Docker password
--dockerRegistry=<value> Docker registry
--dockerUsername=<value> Docker username
--gdocsApiKey=<value> Google Docs API key
--gdocsDocumentId=<value> Google Docs document ID
--gdocsServiceAccountJson=<value> Google Docs service account JSON
--githubBranch=<value> GitHub branch
--githubRepo=<value> GitHub repo (org/repo)
--githubToken=<value> GitHub token
--hash=<value> Asset hash
--s3AccessKey=<value> S3 access key
--s3Bucket=<value> S3 bucket
--s3Endpoint=<value> S3 endpoint
--s3Path=<value> S3 path
--s3Region=<value> S3 region
--s3SecretKey=<value> S3 secret key
--size=<value> Asset size in bytes
--storjBucket=<value> Storj bucket
--storjPath=<value> Storj path
--storjToken=<value> Storj access token
--tag=<value> Asset tag
GLOBAL FLAGS
--json Format output as json.
--[no-]tty Force or disable interactive mode (use --no-tty to disable).
DESCRIPTION
Asset management
Create a new asset.
EXAMPLES
$ sp assets create
$ sp assets create --fromFile ./asset.json
$ sp assets create --name "dataset-v1" --type data --sourceType s3 --s3Bucket b --s3Path p --s3AccessKey a --s3SecretKey s --s3Region us-east-1See code: src/commands/assets/create.ts
sp assets delete
Asset management
USAGE
$ sp assets delete [--json] [--tty] [-f] [-i <value>] [-n <value>]
FLAGS
-f, --force Delete without confirmation
-i, --id=<value> Asset ID to delete
-n, --name=<value> Asset name to delete
GLOBAL FLAGS
--json Format output as json.
--[no-]tty Force or disable interactive mode (use --no-tty to disable).
DESCRIPTION
Asset management
Delete an asset.
EXAMPLES
$ sp assets delete --id 11111111-1111-1111-1111-111111111111
$ sp assets delete --name "dataset-v1" --forceSee code: src/commands/assets/delete.ts
sp assets get
Asset management
USAGE
$ sp assets get [--json] [--tty] [-i <value>] [-n <value>]
FLAGS
-i, --id=<value> Asset ID to fetch
-n, --name=<value> Asset name to fetch
GLOBAL FLAGS
--json Format output as json.
--[no-]tty Force or disable interactive mode (use --no-tty to disable).
DESCRIPTION
Asset management
Get information about an asset.
EXAMPLES
$ sp assets get --id 11111111-1111-1111-1111-111111111111
$ sp assets get --name "dataset-v1"See code: src/commands/assets/get.ts
sp assets list
Asset management
USAGE
$ sp assets list [--json] [--tty]
GLOBAL FLAGS
--json Format output as json.
--[no-]tty Force or disable interactive mode (use --no-tty to disable).
DESCRIPTION
Asset management
List assets for the current user.
EXAMPLES
$ sp assets listSee code: src/commands/assets/list.ts
sp assets update
Asset management
USAGE
$ sp assets update [--json] [--tty] [-f <value>] [-i <value>] [-n <value>] [--newName <value>] [-t
data|image|output] [-s storj|s3|dockerhub|github|google-docs] [--tag <value>] [--hash <value>] [--size <value>]
[--storjBucket <value>] [--storjPath <value>] [--storjToken <value>] [--s3Bucket <value>] [--s3Path <value>]
[--s3AccessKey <value>] [--s3SecretKey <value>] [--s3Region <value>] [--s3Endpoint <value>] [--dockerImage <value>]
[--dockerRegistry <value>] [--dockerUsername <value>] [--dockerPassword <value>] [--githubRepo <value>]
[--githubToken <value>] [--githubBranch <value>] [--gdocsDocumentId <value>] [--gdocsApiKey <value>]
[--gdocsServiceAccountJson <value>]
FLAGS
-f, --fromFile=<value> Path to a JSON file that contains asset update definition.
-i, --id=<value> Asset ID to update
-n, --name=<value> Asset name to update
-s, --sourceType=<option> New source type
<options: storj|s3|dockerhub|github|google-docs>
-t, --type=<option> New asset type
<options: data|image|output>
--dockerImage=<value> Docker image
--dockerPassword=<value> Docker password
--dockerRegistry=<value> Docker registry
--dockerUsername=<value> Docker username
--gdocsApiKey=<value> Google Docs API key
--gdocsDocumentId=<value> Google Docs document ID
--gdocsServiceAccountJson=<value> Google Docs service account JSON
--githubBranch=<value> GitHub branch
--githubRepo=<value> GitHub repo (org/repo)
--githubToken=<value> GitHub token
--hash=<value> New asset hash
--newName=<value> New asset name
--s3AccessKey=<value> S3 access key
--s3Bucket=<value> S3 bucket
--s3Endpoint=<value> S3 endpoint
--s3Path=<value> S3 path
--s3Region=<value> S3 region
--s3SecretKey=<value> S3 secret key
--size=<value> New asset size in bytes
--storjBucket=<value> Storj bucket
--storjPath=<value> Storj path
--storjToken=<value> Storj access token
--tag=<value> New asset tag
GLOBAL FLAGS
--json Format output as json.
--[no-]tty Force or disable interactive mode (use --no-tty to disable).
DESCRIPTION
Asset management
Update an existing asset.
EXAMPLES
$ sp assets update --id 11111111-1111-1111-1111-111111111111 --fromFile ./asset-update.json
$ sp assets update --name "dataset-v1"
$ sp assets update --id 11111111-1111-1111-1111-111111111111 --newName "dataset-v2"
$ sp assets update --id 11111111-1111-1111-1111-111111111111 --sourceType s3 --s3Bucket b --s3Path p --s3AccessKey a --s3SecretKey s --s3Region us-east-1See code: src/commands/assets/update.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 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 and account creation for SuperProtocol
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 and account creation for SuperProtocol
Login to SuperProtocol (sign up or sign in).
ALIASES
$ sp login
EXAMPLES
$ sp login