Migration update

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

Command Reference

Overview of the main qmims commands and global help options

qmims provides four main commands for generating, editing, configuring, and managing README workflows. This page gives you a quick overview of each command and points you to the detailed reference page for its syntax, options, and examples.

generate

Create a new README or regenerate documentation from project context

qmims generate [path] [options]

edit

Update an existing Markdown file using embedded qmims instructions

qmims edit [file] [options]

config

Manage saved qmims defaults and workflow preferences

qmims config <action> [key] [value]

templates

List, inspect, add, and remove README templates

qmims templates <action> [name] [path]

Typical Workflow

Use qmims generate to create a first-pass README.
Refine structure with template mode or custom templates.
Add targeted embedded comments like  to control specific sections.
Run qmims edit to process those instructions and update the file.
Use qmims config to save defaults for repeated workflows.

Global Options

These common flags are available from the CLI help output and are useful when exploring commands:

Option	Description
--help	Show general help or command-specific help
--version	Show the installed qmims version

Command-Specific Flags You'll Use Often

Flag	Common Usage
--mode	Choose between `auto`, `template[:name]`, and `instruct[:file]` for generation
--output	Set a custom output filename such as `DOCS.md`
--force	Overwrite an existing file without the normal prompt
--yes	Automatically approve the Kiro tool-permission flow for non-interactive execution
--dry-run	Preview what qmims would do without making changes
--verbose	Print more detailed diagnostic output

Getting Help

Use the built-in help output whenever you want the exact syntax for the command installed on your machine:

1
2
3
4
5
qmims --help
qmims generate --help
qmims edit --help
qmims config --help
qmims templates --help

If you are troubleshooting Kiro-related setup or authentication issues, the installation and troubleshooting guides also cover the most useful supporting commands such as kiro-cli whoami, kiro-cli login, and kiro-cli doctor.