Manage Blocklet Server

The blocklet server command is your primary tool for managing the lifecycle of a Blocklet Server instance. It allows you to initialize, start, stop, and maintain your server and all the blocklets running on it.

For a practical walkthrough of setting up a new server, see the Getting Started guide.

Usage#

All server management commands follow a consistent structure:

Global Options#

These options can be applied to any blocklet server command.

Option	Alias	Description
--config [node-config]	-c	Specifies the path to the Blocklet Server configuration file.
--yes	-y	Automatically answers "yes" to any confirmation prompts.

Server Lifecycle#

The following diagram illustrates the typical command flow for managing a Blocklet Server instance:

Commands#

The blocklet server command suite is organized into several subcommands, each responsible for a specific aspect of server management. Click on a command to view its detailed documentation, including all available options and examples.

Command	Description
init	Initializes a new Blocklet Server configuration.
start	Starts the Blocklet Server and its related services.
stop	Stops the Blocklet Server and all running blocklets.
status	Displays the current status of the server and installed blocklets.
logs	Shows log files for the server and blocklets.
info	Gathers environment information for debugging and issue reporting.
upgrade	Upgrades the Blocklet Server to the latest version.
cleanup	Performs server-level cleanup tasks, such as clearing caches.
rescue	Attempts to restart all blocklets on a running server.
migration	Migrates the server database from one system to another (e.g., SQLite to Postgres).

Now that you have an overview of server management, you can dive into the specifics of each command. A good place to start is the init command to set up your first server instance.