Migration update

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

Working with Templates

Use built-in and custom templates to generate structured README files with qmims

Templates give you a repeatable README structure while still letting qmims use Kiro CLI to generate the actual content. They are useful when you want consistency across projects, teams, or repository types.

How template mode works

In template mode, qmims writes the selected template to the target Markdown file first, then asks Kiro to analyze your project and fill in the relevant sections while preserving that structure.

Using Templates

Generate a README from a built-in or custom template with:

qmims generate --mode template:templateName

For example, to use the detailed template:

qmims generate --mode template:detailed

To list available templates:

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

Built-in Templates

qmims ships with several built-in templates for common documentation styles:

Basic Template

Good for general-purpose projects with a simple README shape.

Project title and short overview
Installation
Usage
License

# Project Name

## Overview

Add a concise description here.

## Installation

Document installation steps here.

## Usage

Add common usage examples here.

## License

Describe the license here.

Creating Custom Templates

A custom template is just a Markdown file with the structure you want qmims to use. Keep the template readable and focused on layout rather than trying to embed tool-specific behavior into it.

Example custom template

# Project Name

## Overview

Add a short summary here.

## Why This Exists

Explain the problem the project solves.

## Installation

Add setup instructions here.

## Usage

Add common commands and examples here.

## Project Structure

Summarize important directories or modules here.

## Contributing

Add contribution guidance here.

## License

Describe the license here.

Add the template to qmims

qmims templates add my-template path/to/template.md

Use the template

qmims generate --mode template:my-template

Keep templates structural

Templates work best when they define headings, section order, and expectations clearly. Let qmims and Kiro generate the project-aware content based on the repository itself.

Template Best Practices

Use clear section names

Prefer headings like Overview, Installation, Usage, and License unless your project needs more domain-specific sections.

Match the template to the repo type

Libraries, CLIs, and services benefit from different README structures. Choose or create templates that fit the project rather than forcing every repo into the same shape.

Avoid overloading the template

If a README needs many highly specific rules, generate the base file with a template first, then refine sections using embedded  instructions and qmims edit.

Recommended Workflow

Choose a built-in template or create a custom one
Add the custom template if needed
Generate a README with template mode
Review the generated content
Use qmims edit for targeted follow-up changes if needed

qmims templates add internal-standard docs/templates/internal.md
qmims generate --mode template:internal-standard
qmims edit