@superblocksteam/cli v1.6.0
@superblocksteam/cli
Usage
$ npm install -g @superblocksteam/cli
$ superblocks COMMAND
running command...
$ superblocks (--version)
@superblocksteam/cli/1.6.0 linux-x64 node-v18.20.2
$ superblocks --help [COMMAND]
USAGE
$ superblocks COMMAND
...
Commands
superblocks components create
superblocks components register
superblocks components upload
superblocks components watch
superblocks config set PROPERTY VALUE
superblocks help [COMMANDS]
superblocks init [RESOURCE_URL]
superblocks login
superblocks migrate
superblocks pull [RESOURCE_PATH]
superblocks push [RESOURCE_PATH]
superblocks rm [RESOURCE_PATH]
superblocks components create
Creates a new Superblocks component in the current application folder
USAGE
$ superblocks components create [--example]
FLAGS
--example Create example component
DESCRIPTION
Creates a new Superblocks component in the current application folder
superblocks components register
Registers all local component config files
USAGE
$ superblocks components register
DESCRIPTION
Registers all local component config files
EXAMPLES
$ superblocks components register
superblocks components upload
Upload creates a production-ready bundle and saves the files for use outside of Local Development mode.
USAGE
$ superblocks components upload [-b <value>]
FLAGS
-b, --branch=<value> Superblocks branch to push to, the current (local) git branch will be used by default
DESCRIPTION
Upload creates a production-ready bundle and saves the files for use outside of Local Development mode.
EXAMPLES
$ superblocks components upload
$ superblocks components upload -b feature-branch
superblocks components watch
watch for changes to your custom components
USAGE
$ superblocks components watch
DESCRIPTION
watch for changes to your custom components
superblocks config set PROPERTY VALUE
Sets the specified property in your Superblocks configuration. A property governs the behavior of the Superblocks CLI, such as Superblocks region to interact with
USAGE
$ superblocks config set PROPERTY VALUE
ARGUMENTS
PROPERTY (domain) Superblocks config name, e.g. domain
VALUE Superblocks config value
DESCRIPTION
Sets the specified property in your Superblocks configuration. A property governs the behavior of the Superblocks CLI,
such as Superblocks region to interact with
EXAMPLES
$ superblocks config set domain eu.superblocks.com
$ superblocks config set domain app.superblocks.com
superblocks help [COMMANDS]
Display help for superblocks.
USAGE
$ superblocks 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 superblocks.
See code: @oclif/plugin-help
superblocks init [RESOURCE_URL]
Interactively configure the current directory as a Superblocks project or initialize new services in an already configured Superblocks project directory
USAGE
$ superblocks init [RESOURCE_URL] [-m latest-edits|most-recent-commit|deployed]
ARGUMENTS
RESOURCE_URL Superblocks resource URL (i.e. https://app.superblocks.com/applications/<application_id> or
https://app.superblocks.com/applications/edit/<application_id>)
FLAGS
-m, --mode=<option> Pull mode
<options: latest-edits|most-recent-commit|deployed>
DESCRIPTION
Interactively configure the current directory as a Superblocks project or initialize new services in an already
configured Superblocks project directory
EXAMPLES
$ superblocks init
$ superblocks init https://app.superblocks.com/applications/11111111-1111-1111-1111-111111111111/pages/22222222-2222-2222-2222-222222222222
superblocks login
Authenticate with Superblocks cloud
USAGE
$ superblocks login [-t <value>]
FLAGS
-t, --token=<value> Superblocks user API key
DESCRIPTION
Authenticate with Superblocks cloud
superblocks migrate
Migrate files to use the current CLI version
USAGE
$ superblocks migrate
DESCRIPTION
Migrate files to use the current CLI version
EXAMPLES
$ superblocks migrate
superblocks pull [RESOURCE_PATH]
Download objects from Superblocks and save them locally
USAGE
$ superblocks pull [RESOURCE_PATH] [-m latest-edits|most-recent-commit|deployed] [-b <value>]
ARGUMENTS
RESOURCE_PATH Superblocks resource location to pull (i.e. apps/my-app)
FLAGS
-b, --branch=<value> Superblocks branch to pull from, the current git branch will be used by default
-m, --mode=<option> [default: latest-edits] Pull mode
<options: latest-edits|most-recent-commit|deployed>
DESCRIPTION
Download objects from Superblocks and save them locally
EXAMPLES
$ superblocks pull
$ superblocks pull apps/my-app
$ superblocks pull apps/my-app -b feature-branch
superblocks push [RESOURCE_PATH]
Import objects from local filesystem to Superblocks
USAGE
$ superblocks push [RESOURCE_PATH] [-b <value>]
ARGUMENTS
RESOURCE_PATH Superblocks resource location to push (e.g. apps/my-app)
FLAGS
-b, --branch=<value> Superblocks branch to push to, the current git branch will be used by default
DESCRIPTION
Import objects from local filesystem to Superblocks
EXAMPLES
$ superblocks push
$ superblocks push apps/my-app
$ superblocks push apps/my-app -b feature-branch
superblocks rm [RESOURCE_PATH]
Remove a Superblocks resource from the local Superblocks project and delete the resource folder directory locally (if it exists)
USAGE
$ superblocks rm [RESOURCE_PATH]
ARGUMENTS
RESOURCE_PATH Superblocks resource location (i.e. apps/my-spectacular-app)
DESCRIPTION
Remove a Superblocks resource from the local Superblocks project and delete the resource folder directory locally (if
it exists)
EXAMPLES
$ superblocks rm
$ superblocks rm apps/my-spectacular-app
1 day ago
5 days ago
2 months ago
2 months ago
5 months ago
5 months ago
6 months ago
6 months ago
6 months ago
6 months ago
7 months ago
7 months ago
7 months ago
7 months ago
8 months ago
8 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
10 months ago
10 months ago
10 months ago
10 months ago