Show relation options

Relation kinds the metamodel allows from an element, each with the types its target may have (SR-067); search a target with element.search and selection.where: { type: targetTypes }.

Command relation.options. Reads the workspace and changes no file.

Input

Field	Type	Required	Description
`ref`	`elementRef`	yes	The element that gets the relation (its source).
`kind`	`key`	no	Only this relation kind: none when the type of the element does not allow it.

Output

Field	Type	Required	Description
`kinds`	array of `object`	yes	In metamodel order: every relation kind whose source-types allow the type of the element (subtypes count) and whose target-types allow some type; none for an element of a type the metamodel does not know (SR-016 AK3). These are the kinds relation.add accepts.
`kinds[].kind`	`key`	yes	Fixed metamodel key of a type, property, relation kind or status value. Readable English, lower case, dashes (D-043, SR-010 AK2).
`kinds[].name`	`string`	yes	Display name of the relation kind.
`kinds[].targetTypes`	array of `key`	yes	Every type of the metamodel a target may have, subtypes included, in metamodel order; relation.add refuses a target of another known type.

App

In the command prompt (Ctrl+Shift+P, macOS ⌘⇧P): the command Show relation options.

CLI

reqseq relation options, with --json for the output as JSON. Its help:

Usage: reqseq relation options <ref> [options]

Relation kinds the metamodel allows from an element, each with the types its
target may have (SR-067); search a target with element.search and
selection.where: { type: targetTypes }.

Arguments:
  ref                     The element that gets the relation (its source).

Options:
  --ref <value>           instead of the argument <ref>
  --kind <value>          Only this relation kind: none when the type of the
                          element does not allow it.
  --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/relation.options on the local API (reqseq serve api), with the input as the JSON body; the answer is the output.

MCP

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