# health

Run deterministic repository health checks


## When to use it

Write an advisory repository health report. This executor is distinct from the structural checker invoked by the megamono health CLI command. Review coverage and findings, not just process success; see [health coverage and gate semantics](/docs/workflows/governance#read-health-reports-as-advice).

## Usage

Configure an Nx target on the owning project, then invoke it with `npm exec -- nx run <project>:<target>`. The executor identifier is not a standalone CLI command.

```json
{
  "targets": {
    "reviewed-action": {
      "executor": "@megamono/plugin:health",
      "options": {}
    }
  }
}
```

This target is a configuration example. Supply required values and review side effects before invoking it.

## Options

Use these options with `@megamono/plugin:health`. Nx uses the camelCase names shown here; the [CLI reference](/docs/cli) describes command-line aliases. Some options are required only for particular choices.

| Option | Required | Type | Default | Description |
| --- | --- | --- | --- | --- |
| `config` | No | string | "megamono.json" | Workspace-relative Megamono configuration path. |
| `docsRoot` | No | string | — | Override the configured documentation root. |
| `checks` | No | array | — | — |
| `output` | No | string | ".megamono/health.json" | Workspace-relative JSON report path. |
| `failOnFindings` | No | boolean | false | Return an unsuccessful Nx result when findings exist. |
| `now` | No | string | — | Reference time for deterministic fixtures. |

## Next steps

Review changed files and run the affected project's checks. For options that accept structured values, run the generator's `--help` or consult the schema in the installed package.

- [All actions](/docs/actions)
- [CLI overview](/docs/cli)
- [Adopt an existing workspace](/docs/workflows/adoption)