Skip to content

Set up a Workspace repository

Scaffold a Workspace repository and check its first local plan.

Set up a Workspace repository with the Merulan CLI.

Prerequisites

Install the Merulan CLI and pnpm. Choose a directory and a Workspace key. The key uses lowercase words separated by hyphens.

Create the repository

Run these commands with your directory and key:

merulan workspace init --dir ./my-workspace --key my-workspace
cd my-workspace
pnpm install
merulan workspace plan --dir .

The generated merulan.json selects the Workspace declaration under src/workspaces/. package.json pins the CDK version. The first plan checks the local declaration. It does not install a live Workspace.

Add a Product

Define a Product in src/products/, or select an exact Product release from Marketplace, then add it to the Workspace declaration. Compose a Workspace shows the declaration and plan. Build Product resources explains how Product code owns its resources.