Command-Line Interface

CLI commands for nbdev project overview generation and analysis

Tree Command

---

source

tree_cmd

 tree_cmd (args:argparse.Namespace)

Generate tree visualization for nbdev project

	Type	Details
args	Namespace	Parsed command line arguments

API Documentation Command

---

source

api_cmd

 api_cmd (args:argparse.Namespace)

Generate API documentation for nbdev project

	Type	Details
args	Namespace	Parsed command line arguments

Dependencies Command

---

source

deps_cmd

 deps_cmd (args:argparse.Namespace)

Analyze and visualize module dependencies

	Type	Details
args	Namespace	Parsed command line arguments

Overview Command

---

source

overview_cmd

 overview_cmd (args:argparse.Namespace)

Generate complete project overview

	Type	Details
args	Namespace	Parsed command line arguments

Update Index Command

---

source

update_index_cmd

 update_index_cmd (args:argparse.Namespace)

Update index.ipynb with module documentation

	Type	Details
args	Namespace	Parsed command line arguments

---

source

update_comprehensive_cmd

 update_comprehensive_cmd (args:argparse.Namespace)

Comprehensively update index.ipynb with all sections

	Type	Details
args	Namespace	Parsed command line arguments

Main CLI Entry Point

---

source

main

 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