Blocklet Commands

The blocklet command is the primary tool for managing the entire lifecycle of an individual blocklet project. It provides a suite of subcommands to handle tasks such as scaffolding a new project, running a local development server, bundling for production, and deploying to a server or publishing to a Blocklet Store.

For managing the Blocklet Server environment itself, see the blocklet server command set.

Development Workflow#

The following diagram illustrates the typical workflow using blocklet commands, from project creation to deployment.

Command Summary#

The blocklet command suite includes tools for every stage of development. Below is a summary of the available commands. Select a command to view its detailed documentation.

Command	Description	More Info
init	Creates a new, empty blocklet project from scratch.	Details
create	Bootstraps a new blocklet from various starter templates.	Details
dev	Starts a local development environment for a blocklet.	Details
bundle	Packages a blocklet into a distributable format for deployment.	Details
deploy	Deploys a blocklet from a local directory to a Blocklet Server.	Details
upload	Uploads a packaged blocklet to the Blocklet Store.	Details
connect	Connects and authenticates with a Blocklet Store.	Details
config	Manages local CLI configuration settings.	Details
version	Bumps the version of a blocklet in blocklet.yml.	Details
exec	Executes a script within a blocklet's running context.	Details
add	Adds a component dependency to blocklet.yml.	Details
remove	Removes a component dependency from blocklet.yml.	Details
debug	Sets a debug flag or URL for a running blocklet.	Details
test	Sets up and manages a test environment for a blocklet.	Details
cleanup	Performs cleanup operations, such as clearing the cache.	Details
meta	Prints the parsed metadata of a blocklet.	Details
document	Manages the DID Document for a blocklet.	Details
component	Executes commands from the Component Studio CLI.	Details

Global Options#

These options can be used with any blocklet command.

Option	Alias	Description	Default
--yes	-y	Automatically answers yes to any interactive prompts.	false
--help	-h	Displays help information for a command.	false

Now that you have an overview of the command set, a good next step is to create your first blocklet. Follow our guide on Creating a Blocklet to get started.