docs
Introduction

Bedrock CLI Documentation

Bedrock CLI is a toolchain for building Minecraft Bedrock add-ons without fighting your tooling. It pairs a scaffolder (create-mc-bedrock) with a compiler (@keyyard/bedrock-build) so you can go from a blank folder to a hot-reloading TypeScript workspace, and eventually a packaged .mcaddon, without the usual setup tax. It's the approachable middle: past your first tutorial, not yet running a filter pipeline.

The headline feature is the create:* generators. Scaffold once, then one command writes every linked file for a feature: behavior JSON, resource JSON, and the texture and lang registration that goes with it.

These docs cover scaffolding a project, the create generators, the workspace layout, the build pipeline, deploying to your local Minecraft install, and packaging for distribution.

What's new in 3.0 - the generator release

  • create:* generators. The headline feature. Six generators - create:weapon, create:tool, create:armor, create:item, create:entity, create:block - each scaffold a fully wired feature (behavior JSON + resource JSON + texture and lang registration) in one command. Beginners run them with zero flags; CI runs them fully non-interactive.
  • One opinionated starter. The source picker is gone. The scaffolder lays down a single starter wired to the generators. See create-mc-bedrock.
  • Optional derived namespace. Identifiers come from a namespace that is derived from your project name when you omit it. Fully backward-compatible.
  • Same compiler. build, watch, deploy, pack, and deploy:watch hot reload are unchanged. See the CLI reference.