Command-Line Interface

CLI commands for nbdev project overview generation and analysis

Tree Command

---

tree_cmd

def tree_cmd(
    args:argparse.Namespace, # Parsed command line arguments
):

Generate tree visualization for nbdev project

API Documentation Command

---

api_cmd

def api_cmd(
    args:argparse.Namespace, # Parsed command line arguments
):

Generate API documentation for nbdev project

Dependencies Command

---

deps_cmd

def deps_cmd(
    args:argparse.Namespace, # Parsed command line arguments
):

Analyze and visualize module dependencies

Overview Command

---

overview_cmd

def overview_cmd(
    args:argparse.Namespace, # Parsed command line arguments
):

Generate complete project overview

Update Index Command

---

update_index_cmd

def update_index_cmd(
    args:argparse.Namespace, # Parsed command line arguments
):

Update index.ipynb with module documentation

---

update_comprehensive_cmd

def update_comprehensive_cmd(
    args:argparse.Namespace, # Parsed command line arguments
):

Comprehensively update index.ipynb with all sections

Main CLI Entry Point

---

main

def main(
    
):

Main CLI entry point for nbdev-overview

Console Script Registration

For the CLI to work, we need to register it as a console script in the project settings:

# Add this to settings.ini under [options.entry_points]:
# console_scripts = nbdev-overview=cjm_nbdev_overview.cli:main