# amfelt docs check

Verify the project's committed Markdown documentation is up to date.

Compares the documentation already committed under the documentation directory
named by docs.path against what docs generate would currently produce from the
project's data contracts and configuration, without writing anything. It runs
the exact same safety checks docs generate does — refusing a hand-written
Markdown page, a symbolic link, or a directory containing its own .git
repository — so a refusal here means docs generate would refuse too. Intended
for CI: it reports the outcome and sets the process exit code, so a pull request
that changes a contract without regenerating its documentation can be caught
before merge.

A project with docs.enabled set to false is reported and left alone — a project
that never opted in cannot be out of date. Otherwise, every changed, missing and
orphaned page is listed by path, and the command exits non-zero if any are
found. A protected region whose content would be dropped is reported as a
warning either way, since that prose exists nowhere but the page and git
history.

## Usage

```text
amfelt docs check [flags]
```

## Examples

```text
docs check
Verifies that the documentation for the project in the current directory matches
its current data contracts and configuration.

docs check --path pcf/PCF-postgres.yaml
Verifies the documentation for the project defined by the given project file.
```

## Flags

| Flag | Type | Default | Description |
| --- | --- | --- | --- |
| `--path` | `string` | `amfelt.yaml` | path of the Amfelt project file |
| `--strict` | `bool` | `true` | use strict validation |
{.clidoc-flags-table}

## Global flags

| Flag | Type | Default | Description |
| --- | --- | --- | --- |
| `--amfelt-dir` | `string` | `.amfelt` | directory for workspace files (such as plugins); does not move agent identity (controlled by AMFELT_DIR) |
| `--config` | `string` | — | directory or filename of the application configuration |
| `-f`, `--format` | `string` | `default` | log format to use; either default, pretty, or json |
| `-l`, `--level` | `string` | `info` | minimum log level to display; either error, warn, info, or debug |
| `-v`, `--verbose` | `bool` | `false` | trigger to use verbose logging |
{.clidoc-flags-table}

## See also

- [`docs`](/docs/reference/command-line/docs/) — the parent command

---

Generated from `amfelt` v5.6.3.