Module

cli.commands.debug

Debug and diagnostic commands for Bengal.

Commands:

bengal debug incremental - Debug incremental build issues
bengal debug delta - Compare builds and explain changes
bengal debug deps - Visualize build dependencies
bengal debug migrate - Preview content migrations
bengal debug sandbox - Test shortcodes/directives in isolation
bengal debug config-inspect - Advanced configuration inspection

Functions

debug_cli
Debug and diagnostic commands for builds.
0 None
def debug_cli() -> None

Debug and diagnostic commands for builds.

incremental
Debug incremental build issues. Analyzes cache state, explains why pages rebuild, identifies phant…
4 None
def incremental(explain_page: str | None, output_format: str, output_file: str | None, traceback: str | None) -> None

Debug incremental build issues.

Analyzes cache state, explains why pages rebuild, identifies phantom rebuilds, and validates cache consistency.

Parameters 4

Name Type Default Description
explain_page str | None
output_format str
output_file str | None
traceback str | None
delta
Compare builds and explain changes. Shows what changed between builds including added/removed page…
5 None
def delta(baseline: bool, save_baseline: bool, output_format: str, output_file: str | None, traceback: str | None) -> None

Compare builds and explain changes.

Shows what changed between builds including added/removed pages, timing changes, and configuration differences.

Parameters 5

Name Type Default Description
baseline bool
save_baseline bool
output_format str
output_file str | None
traceback str | None
deps
Visualize build dependencies. Shows what a page depends on (templates, partials, data files) and w…
6 None
def deps(page_path: str | None, blast_file: str | None, export_format: str | None, output_file: str | None, max_depth: int, traceback: str | None) -> None

Visualize build dependencies.

Shows what a page depends on (templates, partials, data files) and what would rebuild if a file changed.

Parameters 6

Name Type Default Description
page_path str | None
blast_file str | None
export_format str | None
output_file str | None
max_depth int
traceback str | None
migrate
Preview and execute content migrations. Safely move, split, or merge content while maintaining lin…
5 None
def migrate(move: tuple[str, str] | None, execute: bool, dry_run: bool, redirect_format: str | None, traceback: str | None) -> None

Preview and execute content migrations.

Safely move, split, or merge content while maintaining link integrity and generating redirect rules.

Parameters 5

Name Type Default Description
move tuple[str, str] | None
execute bool
dry_run bool
redirect_format str | None
traceback str | None
sandbox
Test shortcodes/directives in isolation. Renders directives without building the entire site, usef…
7 None
def sandbox(content: str | None, file_path: str | None, validate_only: bool, list_directives: bool, help_directive: str | None, output_format: str, traceback: str | None) -> None

Test shortcodes/directives in isolation.

Renders directives without building the entire site, useful for testing and debugging directive syntax before adding to content.

Parameters 7

Name Type Default Description
content str | None
file_path str | None
validate_only bool
list_directives bool
help_directive str | None
output_format str
traceback str | None
config_inspect
Advanced configuration inspection and comparison. Goes beyond 'bengal config diff' with origin tra…
6 None
def config_inspect(compare_to: str | None, explain_key: str | None, list_sources: bool, find_issues: bool, output_format: str, traceback: str | None) -> None

Advanced configuration inspection and comparison.

Goes beyond 'bengal config diff' with origin tracking, impact analysis, and key-level value resolution explanations.

Parameters 6

Name Type Default Description
compare_to str | None
explain_key str | None
list_sources bool
find_issues bool
output_format str
traceback str | None