CLI command reference

Informative guide. This Book page explains Beskid but does not define the standard. For normative requirements, use the Beskid Standard.

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.

Global behavior

• 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).

Commands

Command	Summary
dev	Group the supported developer aliases
parse	Parse a .bd file and print a debug AST view
tree	Print a textual AST tree
analyze	Run semantic analysis and print diagnostics
format / fmt	Pretty-print sources (file or recursive directory)
doc	Emit api.json and index.md for API docs
clif	Lower to CLIF and print IR
run	AOT-compile, link, and execute in a subprocess
test	Discover, filter, and run test items with the current JIT test engine
repl	Evaluate snippets in an interactive JIT session
build	AOT compile and link
mod	Build and clean compiler Mod AOT artifacts
import	Resolve a supported foreign library into link metadata
fetch	Resolve and materialize dependencies
lock	Synchronize Project.lock
update	Update resolution and materialized workspace
corelib	Materialize embedded corelib template
runtime-kit	Build exact ABI-v5 native runtime kits
new	List, install, and instantiate project/workspace/item templates
pckg	pckg registry client: pack (.bpk with exact semver), upload (artifact-bound version), search, download, yank, …
graph	Render project and workspace graphs
hi	Open the project-aware terminal dashboard
lsp	Run or install the language server
up	Inspect and select direct-install versions
validate-bsol	Validate a BSOL document against a profile
migrate-bsol	Migrate a BSOL document to a selected profile

The grouped aliases are documented once on the beskid dev page. fmt is the visible alias for beskid format. Use the concise root command in procedures and automation.

The pinned compiler revision contains retired manifest names in some command comments. Its resolver implementation requires .bproj and .bws. This reference uses the implemented file contract. The compiler owner must correct the stale comments in a compiler-owned change.