Crust logoCrust

Overview

Complete API reference for every class, function, type, and error in Crust.

All exports listed here come from @crustjs/core.

Classes

ClassDescription
CrustChainable builder for defining CLI commands with full type inference

Functions

FunctionDescription
parseArgs()Parse argv against arg/flag definitions
validateParsed()Validate a parse result against required-value constraints
resolveCommand()Resolve a subcommand from an argv array
createCommandNode()Create a fresh CommandNode (for downstream packages)
computeEffectiveFlags()Merge inherited + local flags at runtime

Types & Errors

PageDescription
TypesAll type definitions — ArgDef, FlagDef, CommandNode, CrustCommandContext, InferArgs, InferFlags, and more
ErrorsCrustError class, error codes, and structured error details

On this page