Migration update

qmims has been migrated from Amazon Q CLI to Kiro CLI. These docs reflect the current install, authentication, and command workflows.

Generate Command

Create new README files using Kiro-backed generation workflows

The generate command is the main entry point for creating project documentation with qmims. It supports automatic generation, template-driven generation, and instruction-driven generation, all powered by Kiro CLI.

Syntax

qmims generate [path] [options]

Arguments

Argument	Description	Default
path	Path to the project directory to analyze	Current directory

Options

Option	Alias	Description
--output	-o	Output filename. Defaults to `defaults.outputFileName`.
--mode	-m	Generation mode: `auto`, `template[:name]`, or `instruct[:file]`.
--force	-f	Overwrite the output file without prompting.
--yes	-y	Automatically approve Kiro tool permission requests.
--dry-run		Show what would happen without making changes.
--verbose		Print detailed diagnostic output.
--list-available-templates		List built-in and custom templates when using template mode.

Generation Modes

Auto Mode

Auto mode asks Kiro to analyze the target project and generate a complete README from scratch.

qmims generate --mode auto

Template Mode

Template mode writes a selected template first, then asks Kiro to fill in the sections while preserving that structure.

qmims generate --mode template:basic

Instruct Mode

Instruct mode reads embedded  comments from a Markdown file and uses all discovered instructions to produce the final output.

qmims generate --mode instruct
qmims generate --mode instruct:README.md

Examples

Generate a README in auto mode for the current directory:

qmims generate

Generate a README for a specific project:

qmims generate /path/to/project

Generate using a built-in template:

qmims generate --mode template:detailed

List the available templates:

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

Generate to a custom output file:

qmims generate --output DOCS.md

Preview the workflow without changing files:

qmims generate --dry-run

Run with automatic approval for non-interactive workflows:

qmims generate --yes

Generate from embedded instructions in a specific file:

qmims generate --mode instruct:docs/README-template.md

How It Works

qmims verifies that Kiro CLI is installed and authenticated
It selects the requested generation workflow based on --mode
It prepares the target file or template and builds a Kiro prompt
Kiro runs in documented non-interactive CLI mode to generate or update the README
The final Markdown content is written to the output file

Kiro authentication

If the command cannot start, verify your Kiro setup with kiro-cli whoami. If needed, authenticate with kiro-cli login or use KIRO_API_KEY in headless environments.

Tip

You can combine options for a more tailored workflow. For example:

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