Generate Command

Create new README.md files for your projects

Syntax

qmims generate [path] [options]

Argument	Description	Default
path	Path to the project directory	Current directory

Option	Alias	Description
--output	-o	Specify output filename (default: README.md)
--mode	-m	Generation mode (auto, template, instruct)
--force	-f	Overwrite existing files without prompting
--yes	-y	Automatically approve all permission requests
--dry-run		Show what would be done without making changes
--verbose	-V	Show detailed output for debugging
--list-available-templates		List available templates when using template mode

Generate README in auto mode for current directory:

qmims generate

Generate README for a specific project:

qmims generate /path/to/project

Generate using a specific template:

qmims generate --mode template:basic

Generate with a custom output filename:

qmims generate --output DOCS.md

Generate in dry run mode to preview changes:

qmims generate --dry-run

Generate with verbose output for debugging:

qmims generate --verbose

List available templates:

qmims generate --mode template --list-available-templates

You can combine multiple options to customize the generation process. For example:

qmims generate --mode template:detailed --output docs/README.md --force