QMIMS CLI Tool

Command Reference

Detailed documentation for all qmims commands

qmims provides four main commands to help you generate and manage README files for your projects.

generate
Create new README.md files
qmims generate [path] [options]
edit
Modify existing README.md files
qmims edit [file] [options]
config
Manage configuration settings
qmims config <action> [key] [value]
templates
Manage README templates
qmims templates <action> [name] [path]

Global Options

These options are available for all qmims commands:

OptionAliasDescription
--help-hShow help information
--version-vShow version information
--verbose-VShow detailed output for debugging

Command-Specific Options

Each command has its own specific options. Click on a command card above to see detailed documentation for that command.

Getting Help

You can get help for any command by using the --help option:

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