mise generate task-docs

• Usage: mise generate task-docs [FLAGS]
• Effect: modifies state
• Source code: src/cli/generate/task_docs.rs

Generate Markdown documentation for project tasks

Documents the tasks defined for the current directory. Prints to stdout by default. Use --output to write a file, --inject to replace a marked section, or --multi for one file per task.

Flags

• -i --inject — Replace the marked section of the --output file

  Replaces everything between <!-- mise-tasks --> and <!-- /mise-tasks --> in the --output file, so you can rerun it to update the docs. The file must already contain both markers; mise reports an error and leaves the file unchanged if either is missing.

• -I --index — Write only an index of tasks, intended for use with --multi

• -m --multi — Render each task as a separate document; requires --output to be a directory

• -o --output <PATH> — Write the generated docs to a file or directory

• -h --help — Print help

Examples

Print the task documentation

mise generate task-docs

Write the task documentation to TASKS.md

mise generate task-docs --output TASKS.md

Update the marked section of README.md

mise generate task-docs --inject --output README.md

Related documentation

• Tasks and automation.
• mise generate <SUBCOMMAND>.
• Global flags and argument syntax.