Problem
Two public API elements have no user documentation:
delegated_display_command — exported in base_cli.__all__ and defined in app.py. It reads os.environ.get("BASE_CLI_DISPLAY_COMMAND") (the constant DISPLAY_COMMAND_ENV at app.py:91) to override what label appears in invocation logs and history when a command is launched by a wrapper rather than directly by the user. This is exactly the kind of detail a consumer building a launcher script or a base-cli-on-top-of-base-cli integration needs.
BASE_CLI_DISPLAY_COMMAND environment variable — no documentation anywhere in the repo. Environment variables that affect runtime behavior belong in the docs alongside the API that reads them.
Neither appears in any doc file (grep -r "delegated_display_command\|DISPLAY_COMMAND" docs/ returns nothing).
Fix
Add a paragraph to docs/consumer-profiles.md (or a dedicated env-vars section) explaining:
- What
delegated_display_command does
- When to use it (wrapper scripts, launchers, delegated invocation)
- The
BASE_CLI_DISPLAY_COMMAND environment variable with an example:
BASE_CLI_DISPLAY_COMMAND="myorg deploy" python -m myapp deploy --env prod
# History and logs record "myorg deploy" rather than the internal module name
Also add a docstring to the function itself.
Problem
Two public API elements have no user documentation:
delegated_display_command— exported inbase_cli.__all__and defined inapp.py. It readsos.environ.get("BASE_CLI_DISPLAY_COMMAND")(the constantDISPLAY_COMMAND_ENVatapp.py:91) to override what label appears in invocation logs and history when a command is launched by a wrapper rather than directly by the user. This is exactly the kind of detail a consumer building a launcher script or a base-cli-on-top-of-base-cli integration needs.BASE_CLI_DISPLAY_COMMANDenvironment variable — no documentation anywhere in the repo. Environment variables that affect runtime behavior belong in the docs alongside the API that reads them.Neither appears in any doc file (
grep -r "delegated_display_command\|DISPLAY_COMMAND" docs/returns nothing).Fix
Add a paragraph to
docs/consumer-profiles.md(or a dedicated env-vars section) explaining:delegated_display_commanddoesBASE_CLI_DISPLAY_COMMANDenvironment variable with an example:Also add a docstring to the function itself.