> ## Documentation Index > Fetch the complete documentation index at: https://getquality.md/llms.txt > Use this file to discover all available pages before exploring further. # CLI reference > The qualitymd command-line interface that the /quality skill builds on. The `/quality` skill drives the `qualitymd` CLI for you. This reference is for when you want to run commands directly. It is generated from the CLI's own command definitions, so it always matches the installed binary. ## Commands | Command | Description | | - | - | | `qualitymd evaluation` | Work with QUALITY.md evaluation runs | | `qualitymd init` | Scaffold a starter QUALITY.md | | `qualitymd lint` | Validate a QUALITY.md file | | `qualitymd model` | Query a quality model's structure and canonical reference IDs | | `qualitymd spec` | Emit the QUALITY.md format specification | | `qualitymd schema` | Emit the companion JSON Schema for QUALITY.md frontmatter | | `qualitymd status` | Show a QUALITY.md workspace status snapshot | | `qualitymd update` | Update the qualitymd CLI through its owning install channel | | `qualitymd version` | Show structured qualitymd version metadata | ## `qualitymd evaluation` Work with QUALITY.md evaluation runs ```bash theme={null} qualitymd evaluation <subcommand> [flags] ``` **Subcommands** | Command | Description | | - | - | | `qualitymd evaluation run` | Execute a complete evaluation run with the deterministic runner | | `qualitymd evaluation create` | Create a numbered evaluation run folder | | `qualitymd evaluation list` | List evaluation runs | | `qualitymd evaluation status` | Show whether an evaluation run is reportable | | `qualitymd evaluation data` | Work with evaluation structured data | | `qualitymd evaluation report` | Build evaluation reports | ### `qualitymd evaluation run` Execute a complete evaluation run with the deterministic runner ```bash theme={null} qualitymd evaluation run [flags] ``` **Flags** | Flag | Description | | - | - | | `--model` | QUALITY.md file to evaluate | | `--evaluation-dir` | Override the model-relative evaluation directory | | `--area` | Canonical area reference for the evaluation scope | | `--factor` | Canonical factor reference for a scoped evaluation; repeatable | | `--evaluator` | Evaluator to use: auto (default), harness, codex, claude, or a configured agent-runtime profile | | `--resume` | Resume an existing run from its evaluation.json | | `--evaluator-result` | Submit harness result envelopes for outstanding work requests | | `--dry-run`, `-n` | Preview the resolved run without invoking an evaluator or writing evaluation data | | `--json` | Emit a machine-readable run receipt | ### `qualitymd evaluation create` Create a numbered evaluation run folder ```bash theme={null} qualitymd evaluation create [flags] [<model>] ``` **Flags** | Flag | Description | | - | - | | `--model` | QUALITY.md file to snapshot | | `--area` | Canonical area reference for the evaluation scope | | `--factor` | Canonical factor reference for a scoped evaluation; repeatable | | `--evaluation-dir` | Override the model-relative evaluation directory | | `--json` | Emit a machine-readable run creation receipt | ### `qualitymd evaluation list` List evaluation runs ```bash theme={null} qualitymd evaluation list [flags] ``` **Flags** | Flag | Description | | - | - | | `--model` | QUALITY.md file that anchors evaluation history | | `--evaluation-dir` | Override the model-relative evaluation directory | | `--state` | Filter runs: all, reportable, incomplete, awaiting | | `--json` | Emit a machine-readable run list | ### `qualitymd evaluation status` Show whether an evaluation run is reportable ```bash theme={null} qualitymd evaluation status [flags] [<run>] ``` **Flags** | Flag | Description | | - | - | | `--latest` | Use the most recent evaluation run | | `--evaluation-dir` | Override the model-relative evaluation directory when using --latest | | `--model` | QUALITY.md file that anchors model-relative run paths | | `--json` | Emit a machine-readable status document | ### `qualitymd evaluation data` Work with evaluation structured data ```bash theme={null} qualitymd evaluation data <subcommand> [flags] ``` **Subcommands** | Command | Description | | - | - | | `qualitymd evaluation data set` | Validate and persist a batch of evaluation JSON payloads | | `qualitymd evaluation data list` | List stored evaluation JSON payloads | | `qualitymd evaluation data get` | Print one stored evaluation JSON payload | | `qualitymd evaluation data kinds` | List evaluation data kinds | | `qualitymd evaluation data example` | Print a complete evaluation example JSON payload | | `qualitymd evaluation data schema` | Print the evaluation structured data JSON Schema | | `qualitymd evaluation data verify` | Validate persisted evaluation JSON payloads | #### `qualitymd evaluation data set` Validate and persist a batch of evaluation JSON payloads ```bash theme={null} qualitymd evaluation data set [flags] [<run>] ``` **Flags** | Flag | Description | | - | - | | `--latest` | Use the most recent evaluation run | | `--evaluation-dir` | Override the model-relative evaluation directory when using --latest | | `--model` | QUALITY.md file that anchors model-relative run paths | | `--dry-run`, `-n` | Validate and report intended write without persisting | | `--json` | Emit a machine-readable write receipt | #### `qualitymd evaluation data list` List stored evaluation JSON payloads ```bash theme={null} qualitymd evaluation data list [flags] [<run>] ``` **Flags** | Flag | Description | | - | - | | `--latest` | Use the most recent evaluation run | | `--evaluation-dir` | Override the model-relative evaluation directory when using --latest | | `--model` | QUALITY.md file that anchors model-relative run paths | | `--kind` | Filter by evaluation data kind | | `--json` | Emit a machine-readable data list | #### `qualitymd evaluation data get` Print one stored evaluation JSON payload ```bash theme={null} qualitymd evaluation data get [flags] [<run>] ``` **Flags** | Flag | Description | | - | - | | `--latest` | Use the most recent evaluation run | | `--evaluation-dir` | Override the model-relative evaluation directory when using --latest | | `--model` | QUALITY.md file that anchors model-relative run paths | | `--kind` | Evaluation data kind | | `--area` | Area ref | | `--factor` | Factor ref | | `--requirement` | Requirement ref | | `--selector` | Optional sub-result selector | | `--json` | Not supported: data get already emits JSON | #### `qualitymd evaluation data kinds` List evaluation data kinds ```bash theme={null} qualitymd evaluation data kinds [flags] ``` **Flags** | Flag | Description | | - | - | | `--json` | Emit a machine-readable data kind list | #### `qualitymd evaluation data example` Print a complete evaluation example JSON payload ```bash theme={null} qualitymd evaluation data example [flags] <kind> ``` **Flags** | Flag | Description | | - | - | | `--json` | Not supported: data example already emits JSON | #### `qualitymd evaluation data schema` Print the evaluation structured data JSON Schema ```bash theme={null} qualitymd evaluation data schema [flags] [<kind>] ``` **Flags** | Flag | Description | | - | - | | `--json` | Not supported: data schema already emits JSON | #### `qualitymd evaluation data verify` Validate persisted evaluation JSON payloads ```bash theme={null} qualitymd evaluation data verify [flags] [<run>] ``` **Flags** | Flag | Description | | - | - | | `--latest` | Use the most recent evaluation run | | `--evaluation-dir` | Override the model-relative evaluation directory when using --latest | | `--model` | QUALITY.md file that anchors model-relative run paths | | `--json` | Emit a machine-readable verification receipt | ### `qualitymd evaluation report` Build evaluation reports ```bash theme={null} qualitymd evaluation report <subcommand> [flags] ``` **Subcommands** | Command | Description | | - | - | | `qualitymd evaluation report build` | Build the complete Markdown report tree for an evaluation run | #### `qualitymd evaluation report build` Build the complete Markdown report tree for an evaluation run ```bash theme={null} qualitymd evaluation report build [flags] [<run>] ``` **Flags** | Flag | Description | | - | - | | `--latest` | Use the most recent evaluation run | | `--evaluation-dir` | Override the model-relative evaluation directory when using --latest | | `--model` | QUALITY.md file that anchors model-relative run paths | | `--json` | Emit a machine-readable report build receipt | ## `qualitymd init` Scaffold a starter QUALITY.md ```bash theme={null} qualitymd init [flags] [<path>] ``` **Flags** | Flag | Description | | - | - | | `--force` | Overwrite an existing file | | `--json` | Emit a machine-readable JSON init receipt | | `--minimal` | Write a minimal valid skeleton without the guided template prose | | `--no-agent-instructions` | Do not create or update agent instruction files | ## `qualitymd lint` Validate a QUALITY.md file ```bash theme={null} qualitymd lint [flags] [<path>] ``` **Flags** | Flag | Description | | - | - | | `--json` | Emit a machine-readable JSON lint result | | `--fix` | Apply deterministic in-place repairs | ## `qualitymd model` Query a quality model's structure and canonical reference IDs ```bash theme={null} qualitymd model <subcommand> [flags] ``` **Subcommands** | Command | Description | | - | - | | `qualitymd model tree` | Render the model as a containment hierarchy | | `qualitymd model list` | Enumerate model elements with their canonical IDs | | `qualitymd model get` | Show one element's detail and immediate relations | ### `qualitymd model tree` Render the model as a containment hierarchy ```bash theme={null} qualitymd model tree [flags] [<path>] ``` **Flags** | Flag | Description | | - | - | | `--json` | Emit the tree as nested JSON | | `--area` | Root the tree at a canonical area reference (area:\) | | `--depth` | Limit nesting depth; 0 emits only the rooted node | ### `qualitymd model list` Enumerate model elements with their canonical IDs ```bash theme={null} qualitymd model list [flags] [<path>] ``` **Flags** | Flag | Description | | - | - | | `--json` | Emit the enumeration as a JSON array | | `--area` | Restrict output to one area's subtree (area:\) | | `--type` | Restrict output to kinds: area, factor, requirement | ### `qualitymd model get` Show one element's detail and immediate relations ```bash theme={null} qualitymd model get [flags] <id [path]...> ``` **Flags** | Flag | Description | | - | - | | `--json` | Emit the element detail as a JSON object | ## `qualitymd spec` Emit the QUALITY.md format specification ```bash theme={null} qualitymd spec [flags] <argument...> ``` ## `qualitymd schema` Emit the companion JSON Schema for QUALITY.md frontmatter ```bash theme={null} qualitymd schema [flags] <argument...> ``` ## `qualitymd status` Show a QUALITY.md workspace status snapshot ```bash theme={null} qualitymd status [flags] [<path>] ``` **Flags** | Flag | Description | | - | - | | `--json` | Emit a machine-readable workspace status snapshot | ## `qualitymd update` Update the qualitymd CLI through its owning install channel ```bash theme={null} qualitymd update [flags] ``` **Flags** | Flag | Description | | - | - | | `--check` | Check for a newer release without applying it | | `--json` | Emit a machine-readable update result | ## `qualitymd version` Show structured qualitymd version metadata ```bash theme={null} qualitymd version [flags] ``` **Flags** | Flag | Description | | - | - | | `--json` | Emit machine-readable version metadata | This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.