Analyse ReqIF file

Preview the import of a ReqIF file: types, attributes and values without mapping; for a repeated delivery the new, changed and dropped requirements and the conflicts with local changes; the losses. Writes nothing.

Command reqif.analyze. Reads the workspace and changes no file.

Input

Field	Type	Required	Description
`file`	`localPath`	yes	A file or folder on the local machine, relative or absolute. CLI: relative to the current folder (the CLI makes it absolute before the call); API and MCP: relative to the workspace root, and only inside the repositories of the workspace, also after links are followed; `~` is not expanded (SR-142, ADR-0009).
`mapping`	`localPath`	no	A file or folder on the local machine, relative or absolute. CLI: relative to the current folder (the CLI makes it absolute before the call); API and MCP: relative to the workspace root, and only inside the repositories of the workspace, also after links are followed; `~` is not expanded (SR-142, ADR-0009).
`source`	`string`	no	Source name for a file of ReqSeq without mapping; default the header TITLE.

Output

Field	Type	Required	Description
`unmapped`	array of `reqifUnmapped`	yes
`new`	array of `reqifObject`	yes	Objects the import would create as new elements, without UUID.
`changed`	array of `reqifObject`	yes	Elements of an earlier delivery of the source (same source IDENTIFIER) whose version with the delivery differs from their import version, conflicts included (SR-056 AK1).
`dropped`	array of `reqifObject`	yes	Elements of the source whose object the file no longer has; the import only lists them (SR-056 AK3).
`conflicts`	array of `reqifObject`	yes	Changed elements that were also changed locally since their import; reqif.import needs take or keep for each (SR-056 AK4).
`losses`	array of `reqifLoss`	yes
`problems`	array of `problem`	no	Warnings: a title, property or relation the import writes over another value (reqif.replaces-local), a repository not on this machine, an element file that cannot be read.

App

In the command prompt (Ctrl+Shift+P, macOS ⌘⇧P): the command Analyse ReqIF file.

CLI

reqseq reqif analyze, with --json for the output as JSON. Its help:

Usage: reqseq reqif analyze <file> [options]

Preview the import of a ReqIF file: types, attributes and values without
mapping; for a repeated delivery the new, changed and dropped requirements and
the conflicts with local changes; the losses. Writes nothing.

Options:
  --file <value>          instead of the argument <file>
  --mapping <value>
  --source <value>        Source name for a file of ReqSeq without mapping;
                          default the header TITLE.
  --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/reqif.analyze on the local API (reqseq serve api), with the input as the JSON body; the answer is the output.

MCP

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