Check workspace

Check the whole workspace against the metamodel: files, required and unknown properties, statuses outside the type and missing statuses, requirements with a statement but no text (a warning), missing targets, cycles, requirements without a parent (a warning, SR-022 AK6), duplicate IDs, outdated relations, evidence records that cannot be read or name an unknown element, a repository that is a workspace of its own whose metamodel counts other properties to the version. ok is false, and the CLI exits 1, on findings at or above failOn (default error).

Command workspace.check. Reads the workspace and changes no file.

Input

Field	Type	Required	Description
`changedFiles`	array of `localPath`	no	Restrict the check to the elements in these files and their targets (SR-092). A file must lie in a repository of the workspace and be no folder; deleted and non-element files add nothing. With changedSince, both count. To cover deleted elements, use changedSince: a deleted file named only in changedFiles adds no old UUID.
`changedSince`	`string`	no	Git revision, e.g. the target commit of a merge request: restrict the check to the elements whose files (or embedded images) in the working copy differ from it, untracked files included, and their targets (SR-092). Looked up in every repository of the workspace; a repository without it, or without Git, adds nothing and gets an info problem (git.revision-missing, git.unavailable). The relations to an element file deleted since, or whose UUID changed, are kept. Error git.commit-not-found (CLI exit code 4) when no repository has it.
`severity`	one of `"error"`, `"warning"`, `"info"`	no	Lowest severity of the problems shown; does not change ok or the exit code. Findings left out are counted in hidden. Default: `"info"`.
`failOn`	one of `"error"`, `"warning"`, `"info"`	no	Lowest severity of a finding that makes ok false (CLI exit code 1), shown or not; independent of severity. With the default, warnings and info never fail the check. Default: `"error"`.

Output

Field	Type	Required	Description
`ok`	`boolean`	yes	False when the workspace has a finding at or above failOn, shown or not (CLI exit code 1, ADR-0009). In a restricted check, of the findings the restriction keeps.
`problems`	array of `problem`	yes
`hidden`	`object`	no	The findings that severity leaves out of problems, by severity; only when it leaves out at least one, so that no problems shown does not read as no findings.
`hidden.below`	one of `"error"`, `"warning"`	yes	The severity given: the findings counted are below it.
`hidden.warning`	`integer`	yes
`hidden.info`	`integer`	yes
`checkedElements`	`integer`	no	Number of elements checked: all of the workspace, or in a restricted check the changed elements and their targets (SR-092).
`durationMs`	`integer`	no	Time the check took in milliseconds. Not given yet: it differs between calls, and the cross-access test compares outputs (SR-080 AK2).

App

In the command prompt (Ctrl+Shift+P, macOS ⌘⇧P): the command Check workspace.

CLI

reqseq workspace check, with --json for the output as JSON. Its help:

Usage: reqseq workspace check [options]

Check the whole workspace against the metamodel: files, required and unknown
properties, statuses outside the type and missing statuses, requirements with a
statement but no text (a warning), missing targets, cycles, requirements without
a parent (a warning, SR-022 AK6), duplicate IDs, outdated relations, evidence
records that cannot be read or name an unknown element, a repository that is a
workspace of its own whose metamodel counts other properties to the version. ok
is false, and the CLI exits 1, on findings at or above failOn (default error).

Options:
  --changed-files <value>  Restrict the check to the elements in these files and
                           their targets (SR-092). A file must lie in a
                           repository of the workspace and be no folder; deleted
                           and non-element files add nothing. With changedSince,
                           both count. To cover deleted elements, use
                           changedSince: a deleted file named only in
                           changedFiles adds no old UUID. repeatable
  --changed-since <value>  Git revision, e.g. the target commit of a merge
                           request: restrict the check to the elements whose
                           files (or embedded images) in the working copy differ
                           from it, untracked files included, and their targets
                           (SR-092). Looked up in every repository of the
                           workspace; a repository without it, or without Git,
                           adds nothing and gets an info problem
                           (git.revision-missing, git.unavailable). The
                           relations to an element file deleted since, or whose
                           UUID changed, are kept. Error git.commit-not-found
                           (CLI exit code 4) when no repository has it.
  --severity <value>       Lowest severity of the problems shown; does not
                           change ok or the exit code. Findings left out are
                           counted in hidden. one of: error, warning, info;
                           default: "info"
  --fail-on <value>        Lowest severity of a finding that makes ok false (CLI
                           exit code 1), shown or not; independent of severity.
                           With the default, warnings and info never fail the
                           check. one of: error, warning, info; default: "error"
  --input <json|@file|->   command input as JSON: inline, from a file, or from
                           standard input
  --workspace <path>       workspace root (default: nearest folder upwards with
                           reqseq-workspace.yaml)
  --json                   print exactly the command output as JSON
  --yaml                   print the whole command output as YAML, problems one
                           per line
  -h, --help               show help

API

POST /v1/commands/workspace.check on the local API (reqseq serve api), with the input as the JSON body; the answer is the output.

MCP

Tool workspace_check of the MCP server (reqseq mcp), with the input as its arguments.