bim

CLI Reference

Complete reference for the bim command.

Commands

bim build

Build the site.

bim build [OPTIONS]

Options:

OptionDescriptionDefault
--draftsInclude draft contentfalse
-o, --output <DIR>Output directorydist
--cleanRemove output before buildingfalse

Examples:

# Basic build
bim build

# Include drafts
bim build --drafts

# Custom output directory
bim build --output public

# Clean build
bim build --clean

bim watch

Watch for changes and rebuild.

bim watch [OPTIONS]

Options:

OptionDescriptionDefault
--draftsInclude draft contentfalse
-o, --output <DIR>Output directorydist

Example:

bim watch --drafts

bim serve

Build and serve locally.

bim serve [OPTIONS]

Options:

OptionDescriptionDefault
-p, --port <PORT>Server port3000
--host <HOST>Bind address127.0.0.1
--draftsInclude draftsfalse
-w, --watchWatch for changesfalse

Examples:

# Basic serve
bim serve

# Custom port
bim serve --port 8080

# With watching
bim serve --watch --drafts

# Network accessible
bim serve --host 0.0.0.0

bim prep-images

Process images only.

bim prep-images [OPTIONS]

Options:

OptionDescriptionDefault
--forceReprocess all imagesfalse
-o, --output <DIR>Output directorydist

Examples:

# Process new/changed images
bim prep-images

# Force reprocess all
bim prep-images --force

Exit Codes

CodeMeaning
0Success
1Error

Environment Variables

VariableDescription
RUST_LOGLogging level (e.g., debug, info)

Example:

RUST_LOG=debug bim build

Related: #cli #commands #reference @documentation