Home

stencila init

Initialize a workspace with stencila.toml configuration

Usage

stencila init [OPTIONS] [DIR]

Examples

# Initialize current directory with interactive prompts
stencila init

# Initialize with all defaults (non-interactive)
stencila init --yes

# Initialize a specific directory
stencila init ./my-project

# Initialize with specific options
stencila init --root docs --home index.md

# Initialize with outputs for executable documents
stencila init --outputs docx,pdf

Arguments

NameDescription
[DIR]The workspace directory to initialize. Default value: ..

Options

NameDescription
-y, --yesAccept all defaults without prompting. Possible values: true, false.
--rootSite root directory (skip interactive prompt).
--homeHome page file (skip interactive prompt).
--outputsOutput formats for executable documents (comma-separated).

Note

This creates a stencila.toml configuration file with site settings, routes, and output configurations based on repository analysis.

© 2026 Stencila