Skip to content
Beskid The Beskid Book

Beskid

Jump to a Beskid service

Beskid

Jump to a Beskid service

CLI command reference

Index of beskid subcommands: links to per-command documentation.

CLI command reference

Arguments can be expanded from response files using the @file convention (via the argfile crate), consistent with other Rust CLI tools.

Unless noted, failures print a diagnostic report (miette) and exit non-zero.

  • On launch, the CLI ensures the bundled corelib tree is available (and may print a short message when it materializes or updates a copy). Override the source location with BESKID_CORELIB_SOURCE when developing against a different corelib checkout.
  • Subcommands that need a single resolved .bd entrypoint accept optional --project, --target, and --workspace-member together with --frozen / --locked where project resolution applies (see analyze, doc, run, build, clif, fetch).
CommandSummary
parseParse a .bd file and print a debug AST view
treePrint a textual AST tree
analyzeRun semantic analysis and print diagnostics
format / fmtPretty-print sources (file or recursive directory)
docEmit api.json and index.md for API docs
clifLower to CLIF and print IR
runJIT-compile and execute
testDiscover, filter, and run test items
buildAOT compile and link
fetchResolve and materialize dependencies
lockSynchronize Project.lock
updateUpdate resolution and materialized workspace
corelibMaterialize embedded corelib template
newList, install, and instantiate project/workspace/item templates
pckgpckg registry client: pack (.bpk), upload (registry-assigned version), search, download, yank, …