# theme URL: /api/cli/commands/theme/ Section: commands -------------------------------------------------------------------------------- theme - Bengal window.BENGAL_THEME_DEFAULTS = { appearance: 'dark', palette: 'snow-lynx' }; // Progressive Enhancement System Configuration window.Bengal = window.Bengal || {}; window.Bengal.enhanceBaseUrl = '/bengal/assets/js/enhancements'; window.Bengal.watchDom = true; window.Bengal.debug = false; (function () { try { var defaults = window.BENGAL_THEME_DEFAULTS || { appearance: 'system', palette: '' }; var defaultAppearance = defaults.appearance; if (defaultAppearance === 'system') { defaultAppearance = (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) ? 'dark' : 'light'; } var storedTheme = localStorage.getItem('bengal-theme'); var storedPalette = localStorage.getItem('bengal-palette'); var theme = storedTheme ? (storedTheme === 'system' ? defaultAppearance : storedTheme) : defaultAppearance; var palette = storedPalette ?? defaults.palette; document.documentElement.setAttribute('data-theme', theme); if (palette) { document.documentElement.setAttribute('data-palette', palette); } } catch (e) { document.documentElement.setAttribute('data-theme', 'light'); } })(); Skip to main content Magnifying Glass ESC Recent Clear Magnifying Glass No results for "" Try different keywords or check your spelling Start typing to search... ↑↓ Navigate ↵ Open ESC Close Powered by Lunr ᓚᘏᗢ Documentation Info About Arrow Clockwise Get Started Note Tutorials File Text Content Palette Theming Settings Building Starburst Extending Bookmark Reference Learning Tracks Releases Dev GitHub API Reference bengal CLI Magnifying Glass Search ⌘K Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal List ᓚᘏᗢ Magnifying Glass Search X Close Documentation Info About Arrow Clockwise Get Started Note Tutorials File Text Content Palette Theming Settings Building Starburst Extending Bookmark Reference Learning Tracks Releases Dev GitHub API Reference bengal CLI Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal API Reference __main__ bengal Caret Right Folder Analysis community_detection graph_analysis graph_reporting graph_visualizer knowledge_graph link_suggestions link_types page_rank path_analysis performance_advisor results Caret Right Folder Assets manifest pipeline Caret Right Folder Autodoc base config docstring_parser utils virtual_orchestrator Caret Right Folder Extractors cli openapi python Caret Right Folder Models cli common openapi python Caret Right Folder Cache asset_dependency_map cache_store cacheable compression dependency_tracker page_discovery_cache query_index query_index_registry taxonomy_index utils Caret Right Folder Build Cache autodoc_tracking core file_tracking fingerprint parsed_content_cache rendered_output_cache taxonomy_index_mixin validation_cache Caret Right Folder Indexes author_index category_index date_range_index section_index Caret Right Folder Cli __main__ base site_templates utils Caret Right Folder Commands assets build clean collections config debug explain fix health init perf project serve site skeleton sources theme utils validate Caret Right Folder Graph __main__ bridges communities orphans pagerank report suggest Caret Right Folder New config presets scaffolds site wizard Caret Right Folder Helpers cli_app_loader cli_output config_validation error_handling menu_config metadata progress site_loader traceback validation Caret Right Folder Skeleton hydrator schema Caret Right Folder Templates base registry Caret Right Folder Blog template Caret Right Folder Changelog template Caret Right Folder Default template Caret Right Folder Docs template Caret Right Folder Landing template Caret Right Folder Portfolio template Caret Right Folder Resume template Caret Right Folder Collections errors loader schemas validator Caret Right Folder Config defaults deprecation directory_loader env_overrides environment feature_mappings hash loader merge origin_tracker validators Caret Right Folder Content Layer entry loaders manager source Caret Right Folder Sources github local notion rest Caret Right Folder Content Types base registry strategies Caret Right Folder Core build_context cascade_engine menu section theme Caret Right Folder Asset asset_core css_transforms Caret Right Folder Page computed content metadata navigation operations page_core proxy relationships utils Caret Right Folder Site core data discovery factories page_caches properties section_registry theme Caret Right Folder Debug base config_inspector content_migrator delta_analyzer dependency_visualizer explainer incremental_debugger models reporter shortcode_sandbox Caret Right Folder Discovery asset_discovery content_discovery Caret Right Folder Fonts downloader generator Caret Right Folder Health autofix base health_check report Caret Right Folder Linkcheck async_checker ignore_policy internal_checker models orchestrator Caret Right Folder Validators anchors assets cache config connectivity cross_ref fonts links menu navigation output performance rendering rss sitemap taxonomy tracks Caret Right Folder Directives analysis checkers constants Caret Right Folder Orchestration asset content full_to_incremental incremental menu postprocess related_posts render section static streaming taxonomy Caret Right Folder Postprocess html_output redirects rss sitemap special_pages Caret Right Folder Output Formats index_generator json_generator llm_generator lunr_index_generator txt_generator utils Caret Right Folder Rendering api_doc_enhancer asset_extractor errors jinja_utils link_transformer link_validator pygments_cache renderer template_context template_profiler validator Caret Right Folder Parsers base factory mistune native_html pygments_patch python_markdown Caret Right Folder Pipeline core output thread_local toc transforms Caret Right Folder Plugins badges cross_references inline_icon term variable_substitution Caret Right Folder Directives _icons admonitions badge base button cache cards checklist code_tabs container contracts data_table dropdown embed errors example_label fenced figure glossary icon include list_table literalinclude marimo navigation options rubric steps tabs target term terminal tokens utils validator video Caret Right Folder Template Engine asset_url core environment manifest menu url_helpers Caret Right Folder Template Functions advanced_collections advanced_strings autodoc collections content crossref data dates debug files get_page i18n icons images math_functions navigation pagination_helpers seo strings tables taxonomies theme urls Caret Right Folder Server build_handler component_preview constants dev_server live_reload pid_manager reload_controller request_handler request_logger resource_manager utils Caret Right Folder Services validation Caret Right Folder Themes config Caret Right Folder Utils atomic_write autodoc build_context build_stats build_summary cli_output css_minifier dates dotdict error_handlers file_io file_lock hashing incremental_constants js_bundler live_progress logger metadata observability page_initializer pagination path_resolver paths performance_collector performance_report profile progress retry rich_console sections swizzle text theme_registry theme_resolution thread_local traceback_config traceback_renderer url_normalization url_strategy Cli Commands ᗢ Caret Down Link Copy URL External Open LLM text Copy Copy LLM text Share with AI Ask Claude Ask ChatGPT Ask Gemini Ask Copilot Module cli.commands.theme Theme-related CLI commands (themes, swizzle). View source 14 Functions Functions theme Theme utilities (list/info/discover/install, swizzle). 0 None Caret Right def theme() -> None Theme utilities (list/info/discover/install, swizzle). swizzle 🎨 Copy a theme template/partial to project templates. Swizzling copies a template from the active … 2 None Caret Right def swizzle(template_path: str, source: str) -> None 🎨 Copy a theme template/partial to project templates. Swizzling copies a template from the active theme to your project's templates/ directory, allowing you to customize it while tracking provenance for future updates. Parameters 2 Name Type Default Description template_path str — source str — swizzle_list 📋 List swizzled templates. Shows all templates that have been copied from themes to your project, … 1 None Caret Right def swizzle_list(source: str) -> None 📋 List swizzled templates. Shows all templates that have been copied from themes to your project, along with their source theme for tracking. Parameters 1 Name Type Default Description source str — swizzle_update 🔄 Update swizzled templates if unchanged locally. Checks swizzled templates and updates them from … 1 None Caret Right def swizzle_update(source: str) -> None 🔄 Update swizzled templates if unchanged locally. Checks swizzled templates and updates them from the theme if you haven't modified them locally. Templates you've customized are skipped. Parameters 1 Name Type Default Description source str — list_themes 📋 List available themes. Shows themes from three sources: - Project themes: themes/ directory in y… 1 None Caret Right def list_themes(source: str) -> None 📋 List available themes. Shows themes from three sources: Project themes: themes/ directory in your site Installed themes: Themes installed via pip/uv Bundled themes: Themes included with Bengal Parameters 1 Name Type Default Description source str — info ℹ️ Show theme info for a slug. Displays information about a theme including: - Source location (p… 2 None Caret Right def info(slug: str, source: str) -> None ℹ️ Show theme info for a slug. Displays information about a theme including: Source location (project, installed, or bundled) Version (if installed) Template and asset paths Parameters 2 Name Type Default Description slug str — source str — discover 🔍 List swizzlable templates from the active theme chain. Shows all templates available in your act… 1 None Caret Right def discover(source: str) -> None 🔍 List swizzlable templates from the active theme chain. Shows all templates available in your active theme(s) that can be swizzled (copied) to your project for customization. Parameters 1 Name Type Default Description source str — debug 🐛 Debug theme resolution and template paths. Shows comprehensive information about: - Active theme… 2 None Caret Right def debug(source: str, template: str | None) -> None 🐛 Debug theme resolution and template paths. Shows comprehensive information about: Active theme chain (inheritance order) Template resolution paths (priority order) Template source locations Theme validation (circular inheritance, missing themes) Specific template resolution (if --template provided) Parameters 2 Name Type Default Description source str — template str | None — _get_theme_extends Get the theme that a theme extends. 2 str | None Caret Right def _get_theme_extends(site_root: Path, theme_name: str) -> str | None Get the theme that a theme extends. Parameters 2 Name Type Default Description site_root Path — theme_name str — Returns str | None _validate_theme_chain Validate theme chain and return list of issues. 2 list[str] Caret Right def _validate_theme_chain(site_root: Path, active_theme: str | None) -> list[str] Validate theme chain and return list of issues. Parameters 2 Name Type Default Description site_root Path — active_theme str | None — Returns list[str] _theme_exists Check if a theme exists in any location. 2 bool Caret Right def _theme_exists(site_root: Path, theme_name: str) -> bool Check if a theme exists in any location. Parameters 2 Name Type Default Description site_root Path — theme_name str — Returns bool _get_template_dir_source_type Determine the source type of a template directory. 2 str Caret Right def _get_template_dir_source_type(site_root: Path, template_dir: Path) -> str Determine the source type of a template directory. Parameters 2 Name Type Default Description site_root Path — template_dir Path — Returns str install 📦 Install a theme via uv pip. Installs a theme package from PyPI. NAME may be a package name or a … 2 None Caret Right def install(name: str, force: bool) -> None 📦 Install a theme via uv pip. Installs a theme package from PyPI. NAME may be a package name or a slug. If a slug without prefix is provided, suggests canonical 'bengal-theme-<slug>'. Parameters 2 Name Type Default Description name str — force bool — new 🎨 Create a new theme scaffold. Creates a new theme with templates, partials, and assets. SLUG is t… 5 None Caret Right def new(slug: str, mode: str, output: str, extends: str, force: bool) -> None 🎨 Create a new theme scaffold. Creates a new theme with templates, partials, and assets. SLUG is the theme identifier used in config (e.g., [site].theme = SLUG). Parameters 5 Name Type Default Description slug str — mode str — output str — extends str — force bool — ← Previous sources Next → utils List © 2025 Bengal ᓚᘏᗢ window.BENGAL_LAZY_ASSETS = { tabulator: '/bengal/assets/js/tabulator.min.js', dataTable: '/bengal/assets/js/data-table.js', mermaidToolbar: '/bengal/assets/js/mermaid-toolbar.9de5abba.js', mermaidTheme: '/bengal/assets/js/mermaid-theme.344822c5.js', graphMinimap: '/bengal/assets/js/graph-minimap.cc7e42e3.js', graphContextual: '/bengal/assets/js/graph-contextual.440e59c6.js' }; window.BENGAL_ICONS = { close: '/bengal/assets/icons/close.911d4fe1.svg', enlarge: '/bengal/assets/icons/enlarge.652035e5.svg', copy: '/bengal/assets/icons/copy.3d56e945.svg', 'download-svg': '/bengal/assets/icons/download.04f07e1b.svg', 'download-png': '/bengal/assets/icons/image.c34dfd40.svg', 'zoom-in': '/bengal/assets/icons/zoom-in.237b4a83.svg', 'zoom-out': '/bengal/assets/icons/zoom-out.38857c77.svg', reset: '/bengal/assets/icons/reset.d26dba29.svg' }; Arrow Up X -------------------------------------------------------------------------------- Metadata: - Author: lbliii - Word Count: 1746 - Reading Time: 9 minutes