# _cli_help

URL: /milo-cli/api/milo/_cli_help/
Section: milo
Description: Markdown help generation for CLI command trees.

---

> For a complete page index, fetch /milo-cli/llms.txt.

Open LLM text
(/milo-cli/api/milo/_cli_help/index.txt)

Share with AI

Ask Claude
(https://claude.ai/new?q=Please%20help%20me%20understand%20this%20documentation%3A%20%2Fmilo-cli%2Fapi%2Fmilo%2F_cli_help%2Findex.txt)

Ask ChatGPT
(https://chatgpt.com/?q=Please%20help%20me%20understand%20this%20documentation%3A%20%2Fmilo-cli%2Fapi%2Fmilo%2F_cli_help%2Findex.txt)

Ask Gemini
(https://gemini.google.com/app?q=Please%20help%20me%20understand%20this%20documentation%3A%20%2Fmilo-cli%2Fapi%2Fmilo%2F_cli_help%2Findex.txt)

Ask Copilot
(https://copilot.microsoft.com/?q=Please%20help%20me%20understand%20this%20documentation%3A%20%2Fmilo-cli%2Fapi%2Fmilo%2F_cli_help%2Findex.txt)

Module

#
`_cli_help`

Markdown help generation for CLI command trees.

3Functions

## Functions

`generate_help_all`

1

`str`

▼

Generate a full command tree reference in markdown.

`def generate_help_all(cli: CLI) -> str`

##### Parameters

Name
Type
Description

`cli`
`CLI`

##### Returns

`str`

`_format_cmd_markdown`

3

`None`

▼

Format a single command as markdown.

`def _format_cmd_markdown(cmd: CommandDef | LazyCommandDef, lines: list[str], prefix: str = '') -> None`

##### Parameters

Name
Type
Description

`cmd`
`CommandDef | LazyCommandDef`

`lines`
`list[str]`

`prefix`
`str`

Default:`''`

`_format_group_markdown`

3

`None`

▼

Format a group and its commands as markdown.

`def _format_group_markdown(group: Group, lines: list[str], depth: int) -> None`

##### Parameters

Name
Type
Description

`group`
`Group`

`lines`
`list[str]`

`depth`
`int`