Migration update

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

Generation Modes

Different ways to generate README files with qmims and Kiro CLI

qmims supports three generation modes: Auto, Template, and Instruct. Each mode uses Kiro CLI under the hood, but they differ in how much structure and guidance you provide before generation starts.

Kiro-backed workflow

qmims runs Kiro in documented non-interactive CLI mode. That means the quality of the result still depends on your project context, file structure, and any instructions or templates you provide.

Auto Mode

Fully Automatic

Kiro analyzes your project and generates a complete README with minimal setup.

Template Mode

Structured

Start from a built-in or custom README template and let Kiro fill it in.

Instruct Mode

Precise Control

Use embedded qmims instructions for targeted, section-level guidance.

Auto Mode

Auto mode is the fastest way to generate a README. qmims asks Kiro to inspect the current project and produce a complete Markdown file based on what it finds.

qmims generate --mode auto

In auto mode, qmims typically asks Kiro to:

Analyze the project structure and source files
Identify the language, framework, and dependency signals
Infer the project purpose and main capabilities
Generate a complete README with relevant sections such as overview, installation, and usage
Write the final Markdown back to the target output file

Auto mode is ideal when you want a strong first draft quickly or when a repository has little or no existing documentation.

Best fit

Use auto mode when speed matters more than structure and you want Kiro to make most of the documentation decisions for you.

Choosing the Right Mode

Use Auto Mode when:

You need a quick README draft
You are documenting a new or lightly documented project
You want Kiro to infer the document structure for you

Use Template Mode when:

You want a predictable document structure
You need consistency across repositories
You already know which sections your README should contain

Use Instruct Mode when:

You need precise control over generated content
You want to update targeted sections of an existing README
You want multiple embedded instructions to shape the final file

Related commands

qmims generate
qmims generate --mode template:detailed
qmims generate --mode instruct
qmims edit
qmims generate --dry-run