Stow CLI

The Stow CLI is a command-line tool for managing and publishing blocks to the Stow registry.

Installation

npm install -g @stow-build/cli

Configuration

In the root of your project, create a stow.config.ts file. This config file is used to define the team and project that the blocks belong to.

export default {
  apiKey: 'YOUR_API_KEY',
  projectSlug: 'YOUR_PROJECT_SLUG',
}

The config also supports an optional registryDir property, which can be used to specify the directory that contains the registry items. Defaults to ./public/r.

Publishing

To publish items, run the following command:

stow push

This command will:

1. Publish all items within the registryDir that contain meta.stow.
2. Delete any items that are no longer in the registryDir but exist in the Stow registry.

After pushing items, you can see them in the Stow registry by visiting your project's dashboard.