Command Reference

The Blocklet CLI provides a comprehensive suite of tools for both developing individual blocklets and managing the Blocklet Server environment. The commands are organized into two primary groups:

• blocklet: For managing the entire lifecycle of a blocklet, from creation to deployment.
• blocklet server: For administering the Blocklet Server instance itself.

This reference provides a high-level overview of all available commands. For hands-on tutorials, see the Guides.

Global Options#

The following options are available for all commands.

Option	Description
-V, --version	Output the current version of Blocklet CLI.
-y, --yes	Automatically respond "yes" to all interactive prompts.
-h, --help	Display help information for the specified command.

blocklet Commands#

These commands are used to manage individual blocklet projects. They cover all stages of the development lifecycle, from initializing a project to bundling and deploying it. For a complete list and detailed usage, see the blocklet command reference.

Command	Description
add	Add a component dependency to blocklet.yml.
bundle	Package a blocklet into a distributable format for deployment.
cleanup	Perform cleanup operations, such as clearing cache or backups.
component	Execute Component Studio CLI commands.
config	Manage local configuration for the Blocklet CLI.
connect	Connect and authenticate with a Blocklet Store.
create	Bootstrap a new blocklet project from a starter template.
debug	Set debug environments for a running blocklet.
deploy	Deploy a local blocklet to a Blocklet Server.
dev	Start a local development environment for a blocklet.
document	Manage the DID Document for a blocklet.
exec	Execute a script within a blocklet's running context.
init	Initialize a new, empty blocklet project.
meta	Print the blocklet's metadata.
remove	Remove a component dependency from blocklet.yml.
test	Set up and manage a test environment for a blocklet.
upload	Upload a blocklet to a Blocklet Store.
version	Bump a blocklet's version number.

server Commands#

These commands are used to manage the Blocklet Server instance. You can use them to initialize, start, stop, and monitor the server, as well as perform maintenance tasks. For a complete list and detailed usage, see the server command reference.

Command	Description
cleanup	Perform server-level cleanup work.
info	Get environment information for debugging and issue reporting.
init	Initialize a new Blocklet Server configuration.
logs	Show Blocklet Server and blocklet log files.
rescue	Restart all blocklets in a running server.
start	Start the Blocklet Server.
status	Show the status of the Blocklet Server and all blocklets.
stop	Stop the Blocklet Server and all blocklets.
upgrade	Self-upgrade the Blocklet Server to the latest version.

Now that you have an overview of the command structure, you can explore the detailed documentation for either Blocklet Commands or Server Commands.