Code
How openbq-org/openbb is laid out, and where to start for common changes.
There is no import map for this report yet.
Where to start reading
- Repository root
- Likely public API
- Likely public API
- Likely start-up file
- Likely start-up file
- Suggested starting pointAI
- Suggested starting pointAI
- Suggested starting pointAI
Find files for a task
AIAdd a New Data Provider
- Create provider directory under openbb_platform/providers/{provider_name}/
- Implement provider interface conforming to openbb_platform/providers/__init__.py base classes
- Register provider in extensions.json asset to enable CLI discovery
Add a New CLI Command
- Create command class in cli/openbb_cli/ following existing controller patterns
- Register command in obbject_registry.py to map CLI arguments to platform methods
- Add argparse argument definition in argparse_translator.py
- Write integration test in cli/integration/ following existing test patterns
Add a Charting Extension
- Create extension module under openbb_platform/obbject_extensions/charting/
- Implement chart rendering functions following openbb_platform/obbject_extensions/charting/indicators.md specification
- Register extension in router.json for CLI and platform discovery
Scaffold a New Extension Package
- Run cookiecutter CLI from cookiecutter/openbb_cookiecutter/ to generate project structure
- Define hooks for pre/post-generation in cookiecutter/openbb_cookiecutter/template/hooks/
- Reference CONTRIBUTING.md for extension packaging standards
Change the public API
Trace runtime behavior
Add or update tests
Change build or automation
RepoPilot lists up to 500 files, so a file missing here may still exist.
- Files marked “likely” are guessed from their names.