# cli URL: /api/autodoc/extractors/cli/ Section: extractors -------------------------------------------------------------------------------- cli - 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 Autodoc Extractors ᗢ 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 autodoc.extractors.cli CLI documentation extractor for autodoc system. Extracts documentation from command-line applications built with Click, argparse, or Typer. View source 1 Class 2 Functions Classes CLIExtractor Extract CLI documentation from Click/argparse/typer applications. This extractor introspects CLI f… 13 Caret Right Extract CLI documentation from Click/argparse/typer applications. This extractor introspects CLI frameworks to build comprehensive documentation for commands, options, arguments, and their relationships. Currently supported frameworks: Click (full support) argparse (planned) Typer (planned) Inherits from Extractor Methods 3 extract Extract documentation from CLI application. 1 list[DocElement] Caret Right def extract(self, source: Any) -> list[DocElement] Extract documentation from CLI application. Parameters 1 source Any CLI application object - For Click: click.Group or click.Command - For argparse: ArgumentParser instance - For Typer: Typer app instance Returns list[DocElement] — List of DocElements representing the CLI structure get_template_dir Get the template directory name for this extractor. 0 str Caret Right def get_template_dir(self) -> str Get the template directory name for this extractor. Returns str — Template directory name (e.g., 'cli', 'python', 'openapi') get_output_path Determine output path for CLI element. 1 Path Caret Right def get_output_path(self, element: DocElement) -> Path Determine output path for CLI element. Parameters 1 element DocElement CLI DocElement Returns Path — Relative path for the generated markdown file Internal Methods 10 Caret Right __init__ Initialize CLI extractor. 2 None Caret Right def __init__(self, framework: str = 'click', include_hidden: bool = False) Initialize CLI extractor. Parameters 2 framework str CLI framework to extract from ('click', 'argparse', 'typer') include_hidden bool Include hidden commands (default: False) _extract_from_click Extract documentation from Click command group. 1 list[DocElement] Caret Right def _extract_from_click(self, cli: click.Group) -> list[DocElement] Extract documentation from Click command group. Parameters 1 cli click.Group Click Group or Command instance Returns list[DocElement] — List containing the main CLI element and all subcommands as separate pages _extract_click_group Extract Click command group documentation. 2 DocElement Caret Right def _extract_click_group(self, group: click.Group, parent_name: str | None = None) -> DocElement Extract Click command group documentation. Parameters 2 group click.Group Click Group instance parent_name str | None Parent command name for nested groups Returns DocElement — DocElement representing the command group _extract_click_command Extract Click command documentation. 2 DocElement Caret Right def _extract_click_command(self, cmd: click.Command, parent_name: str | None = None) -> DocElement Extract Click command documentation. Parameters 2 cmd click.Command Click Command instance parent_name str | None Parent group name Returns DocElement — DocElement representing the command _extract_click_parameter Extract Click parameter (option or argument) documentation. 2 DocElement Caret Right def _extract_click_parameter(self, param: click.Parameter, parent_name: str) -> DocElement Extract Click parameter (option or argument) documentation. Parameters 2 param click.Parameter Click Parameter instance parent_name str Parent command qualified name Returns DocElement — DocElement representing the parameter _strip_examples_from_description Remove example blocks from docstring description. 1 str Caret Right def _strip_examples_from_description(self, docstring: str) -> str Remove example blocks from docstring description. Parameters 1 docstring str Full docstring Returns str — Description without Examples section _extract_examples_from_docstring Extract example blocks from docstring. 1 list[str] Caret Right def _extract_examples_from_docstring(self, docstring: str) -> list[str] Extract example blocks from docstring. Parameters 1 docstring str Function or command docstring Returns list[str] — List of example code blocks _extract_from_argparse Extract documentation from argparse ArgumentParser. 1 list[DocElement] Caret Right def _extract_from_argparse(self, parser: Any) -> list[DocElement] Extract documentation from argparse ArgumentParser. Parameters 1 parser Any ArgumentParser instance Returns list[DocElement] — List of DocElements _extract_from_typer Extract documentation from Typer app. Typer is built on top of Click, so we ca… 1 list[DocElement] Caret Right def _extract_from_typer(self, app: Any) -> list[DocElement] Extract documentation from Typer app. Typer is built on top of Click, so we can leverage the existing Click extraction logic. Typer apps expose their underlying Click structure through various methods. Parameters 1 app Any Typer app instance Returns list[DocElement] — List of DocElements _typer_to_click_group Helper to convert a Typer app to a Click group recursively. 1 Any Caret Right def _typer_to_click_group(self, typer_app: Any) -> Any Helper to convert a Typer app to a Click group recursively. Parameters 1 typer_app Any Typer app instance Returns Any — Click group or None Functions _is_sentinel_value Check if a value is a Click sentinel (like UNSET). Click uses sentinel objects to distinguish betw… 1 bool Caret Right def _is_sentinel_value(value: Any) -> bool Check if a value is a Click sentinel (like UNSET). Click uses sentinel objects to distinguish between "not provided" and None. These should not appear in user-facing documentation. Parameters 1 Name Type Default Description value Any — Value to check Returns bool — True if value is a sentinel that should be filtered _format_default_value Format a default value for display, filtering sentinel values. 1 str | None Caret Right def _format_default_value(value: Any) -> str | None Format a default value for display, filtering sentinel values. Parameters 1 Name Type Default Description value Any — The default value to format Returns str | None — Formatted string or None if value should not be displayed Next → extractors 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: 1723 - Reading Time: 9 minutes