Guides

This section provides detailed, step-by-step guides for common development scenarios and advanced tasks. Whether you're starting a new project, developing locally, or preparing to publish, these guides will walk you through the process of building and managing your blocklets with the Blocklet CLI.

Each guide is designed to be a practical, hands-on resource to help you accomplish specific goals.

Create a Blocklet#

Learn how to start a new blocklet project. This guide covers two main approaches: creating a minimal project structure from scratch using blocklet init and bootstrapping a new project from an official template using blocklet create.

Develop a Blocklet#

Discover the local development workflow. This guide explains how to use the blocklet dev command to run a local development server, which provides features like hot-reloading to streamline the process of coding and testing your blocklet.

Publish a Blocklet#

Ready to share your work? This guide details the entire publishing pipeline, from packaging your blocklet into a distributable bundle to connecting to a Blocklet Store and uploading your package for others to use.

Compose Components#

Blocklets can be composed of other blocklets. This guide demonstrates how to manage these relationships by adding or removing other blocklets as component dependencies in your project using the blocklet add and blocklet remove commands.

After following these guides, you will have a practical understanding of the blocklet development lifecycle. For a deeper dive into the underlying principles, see the Core Concepts section, or for a quick lookup of any command, refer to the Command Reference.