Export ReqIF
Export a selection or a saved export profile, or with statements the elements of the mapping’s source, as ReqIF 1.2: IDENTIFIER _ plus the UUID (the source IDENTIFIER for statements), text as XHTML and as reqseq-markdown, relations as SPEC-RELATIONs, targets outside the export as stubs.
Command reqif.export. Writes files in the working tree, never to Git. It is refused while the workspace is read-only. Exports the types and properties of the metamodel, which is missing or faulty.
| Field | Type | Required | Description |
|---|---|---|---|
output |
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). |
selection |
selection |
no | Which elements a command works on: a saved filter, an inline filter, a package, a baseline or explicit IDs, optionally seen through a variant view. |
profile |
string |
no | |
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). |
omitProperties |
array of key |
no | Added to the omitted properties of the mapping and the profile; with mapping, saved in it for later deliveries. |
statements |
boolean |
no |
Output
Section titled “Output”| Field | Type | Required | Description |
|---|---|---|---|
file |
string |
yes | |
elements |
integer |
yes | |
relations |
integer |
yes | |
withoutStatement |
integer |
no | With statements: exported elements without a statement. |
files |
array of string |
no | |
problems |
array of problem |
no |
In the command prompt (Ctrl+Shift+P, macOS ⌘⇧P): the command Export ReqIF.
reqseq reqif export, with --json for the output as JSON. Its help:
Usage: reqseq reqif export <output> [options]
Export a selection or a saved export profile, or with statements the elements ofthe mapping's source, as ReqIF 1.2: IDENTIFIER `_` plus the UUID (the sourceIDENTIFIER for statements), text as XHTML and as `reqseq-markdown`, relations asSPEC-RELATIONs, targets outside the export as stubs.
Options: --output <value> instead of the argument <output> --profile <value> --mapping <value> --omit-properties <value> Added to the omitted properties of the mapping and the profile; with mapping, saved in it for later deliveries. repeatable --statements --no-statements set statements to false --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
Only via --input: selectionPOST /v1/commands/reqif.export on the local API (reqseq serve api), with the input as the JSON body; the answer is the output.
Tool reqif_export of the MCP server (reqseq mcp), with the input as its arguments.