@superblocksteam/cli-ephemeral
v2.0.43
Published
Official Superblocks CLI
Downloads
3
Keywords
Readme
@superblocksteam/cli
Usage
$ npm install -g @superblocksteam/cli-ephemeral
$ superblocks COMMAND
running command...
$ superblocks (--version)
@superblocksteam/cli-ephemeral/2.0.43 linux-x64 node-v20.19.5
$ superblocks --help [COMMAND]
USAGE
$ superblocks COMMAND
...Commands
superblocks cleanupsuperblocks commandssuperblocks commits [RESOURCE_PATH]superblocks components createsuperblocks components registersuperblocks components uploadsuperblocks components watchsuperblocks config set PROPERTY VALUEsuperblocks deploy [RESOURCE_PATH]superblocks devsuperblocks help [COMMAND]superblocks init [RESOURCE_URL]superblocks loginsuperblocks migratesuperblocks pull [RESOURCE_PATH]superblocks push [RESOURCE_PATH]superblocks rm [RESOURCE_PATH]superblocks update [CHANNEL]superblocks upload [RESOURCE_PATH]superblocks version
superblocks cleanup
Detect and remove conflicting versions of the Superblocks CLI
USAGE
$ superblocks cleanup
DESCRIPTION
Detect and remove conflicting versions of the Superblocks CLI
EXAMPLES
$ superblocks cleanupsuperblocks commands
List all superblocks commands.
USAGE
$ superblocks commands [--json] [-c id|plugin|summary|type... | --tree] [--deprecated] [-x | ] [--hidden]
[--no-truncate | ] [--sort id|plugin|summary|type | ]
FLAGS
-c, --columns=<option>... Only show provided columns (comma-separated).
<options: id|plugin|summary|type>
-x, --extended Show extra columns.
--deprecated Show deprecated commands.
--hidden Show hidden commands.
--no-truncate Do not truncate output.
--sort=<option> [default: id] Property to sort by.
<options: id|plugin|summary|type>
--tree Show tree of commands.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List all superblocks commands.See code: @oclif/plugin-commands
superblocks commits [RESOURCE_PATH]
List Superblocks commits for a resource
USAGE
$ superblocks commits [RESOURCE_PATH] [-b <value>] [-l <value>] [-o <value>]
ARGUMENTS
RESOURCE_PATH Superblocks resource location to show commits for (i.e. apps/my-app)
FLAGS
-b, --branch=<value> Superblocks branch to show commits for, the current git branch will be used by default
-l, --limit=<value> [default: 10] Number of commits to be displayed, default is 10
-o, --offset=<value> Number of commits to be skipped before displaying by creation time, default is 0
DESCRIPTION
List Superblocks commits for a resource
EXAMPLES
$ superblocks commits
$ superblocks commits apps/my-app
$ superblocks commits apps/my-app -b feature-branch
$ superblocks commits --limit 20
$ superblocks commits --offset 10superblocks 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 foldersuperblocks components register
Registers all local component config files
USAGE
$ superblocks components register
DESCRIPTION
Registers all local component config files
EXAMPLES
$ superblocks components registersuperblocks 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-branchsuperblocks components watch
watch for changes to your custom components
USAGE
$ superblocks components watch
DESCRIPTION
watch for changes to your custom componentssuperblocks 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.comsuperblocks deploy [RESOURCE_PATH]
Deploy resources to Superblocks
USAGE
$ superblocks deploy [RESOURCE_PATH] [-c <value>]
ARGUMENTS
RESOURCE_PATH The path to the resource to deploy
FLAGS
-c, --commit-id=<value> The commit ID to deploy
DESCRIPTION
Deploy resources to Superblocks
EXAMPLES
$ superblocks deploy
$ superblocks deploy apps/my-app
$ superblocks deploy apps/my-app --commit-id commit-id
$ superblocks deploy --commit-id commit-idsuperblocks dev
Starts a local development server for the current code-mode enabled application
USAGE
$ superblocks dev [--upload-first] [--download-first]
FLAGS
--download-first Download from Superblocks before starting, can overwrite your local files
--upload-first Upload to Superblocks before starting
DESCRIPTION
Starts a local development server for the current code-mode enabled applicationsuperblocks help [COMMAND]
Display help for superblocks.
USAGE
$ superblocks 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 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|draft|most-recent-commit|deployed] [-s]
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|draft|most-recent-commit|deployed>
-s, --skip-signing-verification If true, signature verification for signing enabled organizations will be skipped.
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-222222222222superblocks login
Authenticate with Superblocks cloud
USAGE
$ superblocks login [-t <value>]
FLAGS
-t, --token=<value> Superblocks user API key
DESCRIPTION
Authenticate with Superblocks cloudsuperblocks migrate
Migrate files to use the current CLI version
USAGE
$ superblocks migrate
DESCRIPTION
Migrate files to use the current CLI version
EXAMPLES
$ superblocks migratesuperblocks pull [RESOURCE_PATH]
Download objects from Superblocks and save them locally
USAGE
$ superblocks pull [RESOURCE_PATH] [-m latest-edits|draft|most-recent-commit|deployed] [-b <value>] [-c
<value>] [-s]
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
-c, --commit-id=<value> Superblocks commit id to pull, the live edit will be used by default
-m, --mode=<option> [default: draft] Pull mode
<options: latest-edits|draft|most-recent-commit|deployed>
-s, --skip-signing-verification If true, signature verification for signing enabled organizations will be skipped.
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 pull apps/my-app -c commit-idsuperblocks push [RESOURCE_PATH]
Import objects from local filesystem to Superblocks
USAGE
$ superblocks push [RESOURCE_PATH] [-b <value>] [-s] [-f]
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
-f, --force If true, push command will force push the commit even if there are uncommitted changes in the
branch.
-s, --skip-commit If true, push command will only update live edit state along with signature without creating a
commit.
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 push apps/my-app --skip-commitsuperblocks 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-appsuperblocks update [CHANNEL]
update the superblocks CLI
USAGE
$ superblocks update [CHANNEL] [--force | | [-a | -v <value> | -i]] [-b ]
FLAGS
-a, --available See available versions.
-b, --verbose Show more details about the available versions.
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
-v, --version=<value> Install a specific version.
--force Force a re-download of the requested version.
DESCRIPTION
update the superblocks CLI
EXAMPLES
Update to the stable channel:
$ superblocks update stable
Update to a specific version:
$ superblocks update --version 1.0.0
Interactively select version:
$ superblocks update --interactive
See available versions:
$ superblocks update --availableSee code: @oclif/plugin-update
superblocks upload [RESOURCE_PATH]
Upload your local files to Superblocks live edit
USAGE
$ superblocks upload [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
Upload your local files to Superblocks live edit
EXAMPLES
$ superblocks upload
$ superblocks upload apps/my-app
$ superblocks upload apps/my-app -b feature-branchsuperblocks version
USAGE
$ superblocks version [--json] [--verbose]
FLAGS
--verbose Show additional information about the CLI.
GLOBAL FLAGS
--json Format output as json.
FLAG DESCRIPTIONS
--verbose Show additional information about the CLI.
Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.See code: @oclif/plugin-version
