sp-cli

=================

SuperProtocol Command line interface


* sp-cli
* Usage
* Commands

Usage

``sh-session
$ 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 forget
* sp account get-sppi
* sp account info
* sp account list
* sp account login
* sp account switch
* sp assets create
* sp assets delete
* sp assets get
* sp assets list
* sp assets update
* [sp autocomplete [SHELL]](#sp-autocomplete-shell)
* [sp help [COMMAND]](#sp-help-command)
* sp login

sp account forget

Account management

`
USAGE
$ sp account forget [--json] [--tty] [-f] [-n ]

FLAGS
-f, --force Force forget without confirmation
-n, --name= 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" --force
`

_See 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-sppi
`

_See 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 user
`

_See 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 list
`

_See code: src/commands/account/list.ts_

sp account login

Login and account creation for SuperProtocol

`
USAGE
$ sp account login [--json] [--tty] [--name ] [--privateKey ] [--path ] [-y]

FLAGS
-y, --yes Skip questions (generate keys when needed).
--name= Account readable name
--path= Path to account(configuration) file to import
--privateKey= 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 login
`

_See code: src/commands/account/login.ts_

sp account switch

Account management

`
USAGE
$ sp account switch [--json] [--tty] [-n ]

FLAGS
-n, --name= 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 switch
`

_See code: src/commands/account/switch.ts_

sp assets create

Asset management

`
USAGE
$ sp assets create [--json] [--tty] [-f ] [-n ] [-t data|image|output] [-s
storj|s3|dockerhub|github|google-docs] [--tag ] [--hash ] [--size ] [--storjBucket ]
[--storjPath ] [--storjToken ] [--s3Bucket ] [--s3Path ] [--s3AccessKey ]
[--s3SecretKey ] [--s3Region ] [--s3Endpoint ] [--dockerImage ] [--dockerRegistry
] [--dockerUsername ] [--dockerPassword ] [--githubRepo ] [--githubToken ]
[--githubBranch ] [--gdocsDocumentId ] [--gdocsApiKey ] [--gdocsServiceAccountJson ]

FLAGS
-f, --fromFile= Path to a JSON file that contains asset definition.
-n, --name= Asset name
-s, --sourceType= Source type

-t, --type= Asset type

--dockerImage= Docker image
--dockerPassword= Docker password
--dockerRegistry= Docker registry
--dockerUsername= Docker username
--gdocsApiKey= Google Docs API key
--gdocsDocumentId= Google Docs document ID
--gdocsServiceAccountJson= Google Docs service account JSON
--githubBranch= GitHub branch
--githubRepo= GitHub repo (org/repo)
--githubToken= GitHub token
--hash= Asset hash
--s3AccessKey= S3 access key
--s3Bucket= S3 bucket
--s3Endpoint= S3 endpoint
--s3Path= S3 path
--s3Region= S3 region
--s3SecretKey= S3 secret key
--size= Asset size in bytes
--storjBucket= Storj bucket
--storjPath= Storj path
--storjToken= Storj access token
--tag= 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-1
`

_See code: src/commands/assets/create.ts_

sp assets delete

Asset management

`
USAGE
$ sp assets delete [--json] [--tty] [-f] [-i ] [-n ]

FLAGS
-f, --force Delete without confirmation
-i, --id= Asset ID to delete
-n, --name= 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" --force
`

_See code: src/commands/assets/delete.ts_

sp assets get

Asset management

`
USAGE
$ sp assets get [--json] [--tty] [-i ] [-n ]

FLAGS
-i, --id= Asset ID to fetch
-n, --name= 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 list
`

_See code: src/commands/assets/list.ts_

sp assets update

Asset management

`
USAGE
$ sp assets update [--json] [--tty] [-f ] [-i ] [-n ] [--newName ] [-t
data|image|output] [-s storj|s3|dockerhub|github|google-docs] [--tag ] [--hash ] [--size ]
[--storjBucket ] [--storjPath ] [--storjToken ] [--s3Bucket ] [--s3Path ]
[--s3AccessKey ] [--s3SecretKey ] [--s3Region ] [--s3Endpoint ] [--dockerImage ]
[--dockerRegistry ] [--dockerUsername ] [--dockerPassword ] [--githubRepo ]
[--githubToken ] [--githubBranch ] [--gdocsDocumentId ] [--gdocsApiKey ]
[--gdocsServiceAccountJson ]

FLAGS
-f, --fromFile= Path to a JSON file that contains asset update definition.
-i, --id= Asset ID to update
-n, --name= Asset name to update
-s, --sourceType= New source type

-t, --type= New asset type

--dockerImage= Docker image
--dockerPassword= Docker password
--dockerRegistry= Docker registry
--dockerUsername= Docker username
--gdocsApiKey= Google Docs API key
--gdocsDocumentId= Google Docs document ID
--gdocsServiceAccountJson= Google Docs service account JSON
--githubBranch= GitHub branch
--githubRepo= GitHub repo (org/repo)
--githubToken= GitHub token
--hash= New asset hash
--newName= New asset name
--s3AccessKey= S3 access key
--s3Bucket= S3 bucket
--s3Endpoint= S3 endpoint
--s3Path= S3 path
--s3Region= S3 region
--s3SecretKey= S3 secret key
--size= New asset size in bytes
--storjBucket= Storj bucket
--storjPath= Storj path
--storjToken= Storj access token
--tag= 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-1
`

_See 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-cache
`

_See 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 ] [--privateKey ] [--path ] [-y]

FLAGS
-y, --yes Skip questions (generate keys when needed).
--name= Account readable name
--path= Path to account(configuration) file to import
--privateKey= 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
``