Skip to main content
Run substrate init once per project to create the .substrate/ directory that all other commands operate on. It refuses if a .substrate/ already exists in the current directory. If anything fails after the directory is created, init rolls back the partial .substrate/ so you can retry cleanly.

Usage

Options

string
Seed with a starter board. Accepts either the bundled template name web-delivery, or a local directory holding a published workflow. Resolution order: a bundled name resolves bundled; otherwise an existing path is resolved by the network-free external loader. A template that resolves to neither fails before .substrate/ is created.

What It Writes

init creates the following structure in your current directory:
It also appends a managed block to your .gitignore (idempotent — safe to run again):
A bundled template ships default members; a path template carries boards only in v0.7.0. See Publish a Template for the full manifest format.

Output

A bare init (no template) prints no board line. With a template:

See Also

  • substrate add applies a template into a .substrate/ that already exists.