Mercur Cli

Starter flows

Create a new project

npx @mercurjs/cli@canary create my-mercur --template basic

Initialize block config in an existing project

npx @mercurjs/cli@canary init

Discover and inspect blocks

npx @mercurjs/cli@canary search --query review
npx @mercurjs/cli@canary view reviews

Add a block

npx @mercurjs/cli@canary add reviews

Check a block against the registry

npx @mercurjs/cli@canary diff reviews

After add

Always inspect what changed:

• where files landed based on blocks.json aliases
• whether medusa-config.ts needs a module or config update
• whether route or SDK types require codegen
• whether build or tests need to run in touched workspaces

Avoid

• guessing block names without search or view
• running add outside the project root
• assuming blocks are UI-only; many also add backend modules, routes, or workflows
• skipping post-install review of changed files and configuration

Output expectations

When using the CLI in a task summary:

• name the command used
• explain why that command was chosen instead of another
• call out any follow-up verification still required