Command Reference

The Blocklet CLI is the primary tool for managing Blocklet Server instances and developing individual blocklets. It is organized into two main command suites: blocklet server for server lifecycle management, and blocklet for the development workflow.

This section serves as a directory for all available commands. For detailed usage, options, and examples, select one of the command suites below.

blocklet server Quick Reference#

These commands manage the Blocklet Server daemon and its environment.

Command	Description
init	Initializes a new Blocklet Server configuration.
start	Starts the Blocklet Server daemon process.
stop	Stops the running Blocklet Server and all blocklets.
status	Shows the current status of the server and installed blocklets.
logs	Displays log file paths for the server and blocklets.
upgrade	Upgrades the Blocklet Server to the latest version.
migrate	Migrates the database from SQLite to PostgreSQL.
info	Gathers environment information for debugging.
cleanup	Performs various server-level cleanup tasks.

blocklet Quick Reference#

These commands are used to create, develop, package, and distribute blocklets.

Command	Description
create	Bootstraps a new blocklet project from a template.
init	Creates an empty blocklet project structure.
dev	Runs a blocklet in a live-reloading development environment.
test	Sets up and manages a dedicated test environment for your blocklet.
bundle	Packages your blocklet into a deployable bundle.
deploy	Deploys a blocklet from a local directory to a Blocklet Server.
upload	Uploads a bundled blocklet to a blocklet store.
connect	Configures the CLI to connect and authenticate with a blocklet store.
version	Bumps the blocklet version number in blocklet.yml.
add	Adds a component dependency to blocklet.yml.
remove	Removes a component dependency from blocklet.yml.
config	Manages the CLI configuration profile.
exec	Executes a script within a blocklet's running context.
meta	Displays the blocklet's metadata from the current directory.
document	Manages the DID document for a blocklet or the server.
cleanup	Performs various blocklet-level cleanup tasks.