Introduction

qmims (Q, Make It Make Sense!) is a command-line tool that uses Kiro CLI to generate, update, and refine README.md files for your projects. It helps you create clear, comprehensive, and context-aware documentation with minimal effort.

The name qmims originally came from its Amazon Q roots, but the tool has now been fully migrated to Kiro CLI. The name stays the same, while the runtime, installation flow, and authentication guidance now reflect Kiro.

Key Features

• AI-Powered README Generation: Uses Kiro CLI to analyze your codebase and produce relevant documentation
• Multiple Generation Modes:
  • Auto: Fully automatic README generation based on project analysis
  • Template: Use built-in or custom templates to structure your README
  • Instruct: Use embedded instructions for more precise, guided output
• Direct Markdown Editing: Update existing README files using embedded qmims instructions
• Custom Templates: Create and manage reusable README templates
• Configuration Management: Set defaults for generation mode, output filename, and template preferences
• Optional Auto-Approval: Use --yes or config defaults to streamline non-interactive Kiro runs

What is qmims?

qmims is a developer-focused CLI for creating and maintaining project README files. Instead of starting from a blank page, you can let Kiro inspect your repository, infer its structure and purpose, and generate documentation that is actually grounded in your codebase.

You can use qmims to bootstrap a brand-new README, fill in a structured template, or selectively update sections of an existing Markdown file with embedded instructions. That makes it useful both for greenfield projects and for keeping mature repositories documented as they evolve.

How qmims Works

1. qmims checks that Kiro CLI is installed and authenticated
2. It selects a generation or editing workflow based on the command you run
3. It invokes Kiro in documented non-interactive CLI mode
4. Kiro analyzes the project or target Markdown file
5. qmims writes the generated or updated README content back to disk

For interactive setups, you can authenticate with kiro-cli login. For headless or CI environments, Kiro also supports authentication through KIRO_API_KEY.

Why Use qmims?

• Save Time: Generate or refresh README content quickly
• Improve Quality: Produce clearer, more complete project documentation
• Stay Current: Keep docs aligned with your codebase over time
• Control the Workflow: Choose between automatic, structured, and instruction-driven modes
• Work in Automation: Support scripted and CI-friendly usage with Kiro auth options