Migration update
qmims has been migrated from Amazon Q CLI to Kiro CLI. These docs reflect the current install, authentication, and command workflows.
Templates Command
Manage built-in and custom README templates
The templates command helps you inspect, add, and remove templates used by qmims. Templates are useful when you want a consistent README structure across projects while still letting Kiro generate the actual content.
Syntax
qmims templates <action> [name] [path]
Actions
| Action | Description |
|---|---|
| list | List all available templates |
| show | Show the content of a specific template |
| add | Add a custom template from a Markdown file |
| remove | Remove a previously added custom template |
Examples
List all available templates:
qmims templates list
Show the content of the built-in basic template:
qmims templates show basic
Add a custom template from a Markdown file:
qmims templates add my-template path/to/template.md
Remove a custom template you no longer need:
qmims templates remove my-template
Use a template after adding it:
qmims generate --mode template:my-template
Template workflow note
templates command manages template files only. To actually generate a README from a template, use qmims generate --mode template:NAME.Built-in Templates
qmims includes several built-in templates for common project types:
| Template | Description |
|---|---|
| basic | A simple README with essential sections |
| detailed | A more comprehensive README with extended structure |
| minimal | A lightweight README for small or straightforward projects |
| library | A template focused on package and API documentation |
| service | A template tailored to services, APIs, and deployments |
Creating a Custom Template
A custom template is just a Markdown file that provides structure for the generated README. qmims writes the template first, then uses Kiro to analyze the project and fill in the sections.
A simple example template might look like this:
# Project Name ## Overview Add a concise summary here. ## Installation Document installation steps here. ## Usage Add examples and common workflows here. ## License Describe the project's license here.
Save that file, then add it to qmims with the add action:
qmims templates add internal-standard docs/templates/internal.md
Recommended Template Workflow
- Create or choose a template
- Add it with the templates command if it is custom
- Generate a README with
qmims generate --mode template:template-name - Review the generated content and make any final refinements
Tip
qmims config set defaults.templateName your-template.