CLI subcommands and global options

Usage

stencila [OPTIONS] [COMMAND]

Examples

# Get help on all available commands
stencila --help

# Create a new document
stencila new article.md

# Convert a document to another format
stencila convert input.md output.pdf

# Check available formats
stencila formats list

# Execute a document
stencila execute notebook.myst

# Open a document in the browser
stencila open document.md

Subcommands

Command	Description
`new`	Create a new, tracked, document
`init`	Initialize a workspace with stencila.toml configuration
`config`	Manage Stencila configuration
`status`	Get the tracking status of documents
`move`	Move a tracked document
`track`	Start tracking a document
`untrack`	Stop tracking a document
`clean`	Clean the current workspace
`convert`	Convert a document to another format
`merge`	Merge changes from another format
`sync`	Synchronize a document between formats
`push`	Push content to Stencila Cloud and remote services
`pull`	Pull a document from a remote service
`watch`	Enable automatic sync for the workspace or a document
`unwatch`	Disable automatic sync for the workspace or a document
`compile`	Compile a document
`lint`	Lint one or more documents
`execute`	Execute a document
`render`	Render a document
`query`	Query a workspace database
`open`	Open a document in the browser
`publish`	Publish one or more documents
`demo`	Run a terminal demonstration from a document
`outputs`	Manage workspace outputs
`db`	Manage the workspace database
`workflows`	Manage workflow definitions
`agents`	Manage agent definitions
`skills`	Manage agent skills
`models`	Manage and interact with generative AI models
`kernels`	Manage execution kernels
`linters`	Manage linters
`formats`	List and inspect supported formats
`themes`	Manage themes
`prompts`	Manage prompts
`mcp`	Manage MCP (Model Context Protocol) servers
`tools`	Manage tools and environments used by Stencila
`secrets`	Manage secrets
`auth`	Manage OAuth authentication for AI model providers
`serve`	Run the HTTP/Websocket server
`snap`	Capture screenshots and measurements of documents served by Stencila
`lsp`	Run the Language Server Protocol server
`cloud`	Manage Stencila Cloud account
`site`	Manage the workspace site
`signin`	Sign in to Stencila Cloud
`signout`	Sign out from Stencila Cloud
`logs`	Display logs from Stencila Cloud workspace sessions
`upgrade`	Upgrade to the latest version
`uninstall`	Uninstall this command line tool

Options

Name	Description
`--no-preview`	Do not serve a preview of the workspace site. Possible values: `true`, `false`.
`-h, --help`	Print help: `-h` for brief help, `--help` for more details. Possible values: `true`, `false`.
`--yes`	Assume the answer `yes` to any interactive prompts. Possible values: `true`, `false`.
`--debug`	Display debug level logging and detailed error reports. Possible values: `true`, `false`.
`--no-color`	Do not color any output.