Migration update
qmims has been migrated from Amazon Q CLI to Kiro CLI. These docs reflect the current install, authentication, and command workflows.
Installation
How to install and set up qmims with Kiro CLI
qmims requires Node.js 18+ and an available, authenticated Kiro CLI installation. Once both are ready, you can install qmims globally and start generating or editing README files.
Prerequisites
1. Node.js
Install Node.js version 18 or later.
node --version
2. Kiro CLI
Kiro CLI must be installed and authenticated before using qmims.
Kiro migration note
Windows 11: run the official installer command in PowerShell or Windows Terminal, not Command Prompt.
irm 'https://cli.kiro.dev/install.ps1' | iex
Windows 10: use the downloads page instead of the Windows 11 installer flow.
3. Authenticate Kiro CLI
Sign in interactively:
kiro-cli login
Verify that Kiro CLI is available and authenticated:
kiro-cli --version kiro-cli whoami
For remote or SSH environments, device-flow login may be more convenient:
kiro-cli login --use-device-flow
Headless / CI usage
KIRO_API_KEY instead of relying on browser login.# Linux / macOS export KIRO_API_KEY=your_api_key_here
# Windows PowerShell $env:KIRO_API_KEY = "your_api_key_here"
Install qmims
Install qmims globally with npm:
npm install -g qmims
Verify the installation
After installation, confirm that qmims is available:
qmims --version
Then verify your Kiro-backed workflow is ready:
kiro-cli whoami qmims generate --dry-run
Recommended first run
Once everything is installed, a simple first run looks like this:
qmims generate qmims edit
Troubleshooting commands
kiro-cli whoami kiro-cli login kiro-cli doctor