List hints

Open hints of the workspace, filterable by kind, type, package or variant.

Command hint.list. Reads the workspace and changes no file.

Input

Field	Type	Required	Description
kind	array of problemCode	no	Only hints with one of these codes.
type	array of key	no	Only hints about elements of one of these types, or of a type that extends one of them (SR-012).
package	elementRef	no	Only hints about elements whose property with the meaning packages lists this package.
variant	elementRef	no	Only hints about elements in the view of this variant (SR-043); a hint about a variant element only for that variant.
ref	elementRef	no	Only the hints about this element.

Output

Field	Type	Required	Description
hints	array of problem	yes	The open hints: findings of severity warning about one element (glossary “Hinweis”: the element should be checked; it blocks nothing and changes no status), from the same whole-workspace findings as workspace.check; errors, info and warnings about no element are not hints. Filters combine with AND. Each hint with its kind (code), the element it is about (elementId, repository, file, line), its target where it has one (targetId) and its reason (message; for an outdated relation with both versions and their dates, D-013). In the order of workspace.check.
incomplete	incomplete	yes	True while a repository of the workspace file is not on this machine: the hints of its elements are not listed (SR-006 AK2).

App

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

CLI

reqseq hint list, with --json for the output as JSON. Its help:

Usage: reqseq hint list [options]

Open hints of the workspace, filterable by kind, type, package or variant.

Options:
  --kind <value>          Only hints with one of these codes. repeatable
  --type <value>          Only hints about elements of one of these types, or of
                          a type that extends one of them (SR-012). repeatable
  --package <value>       Only hints about elements whose property with the
                          meaning packages lists this package.
  --variant <value>       Only hints about elements in the view of this variant
                          (SR-043); a hint about a variant element only for that
                          variant.
  --ref <value>           Only the hints about this element.
  --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/hint.list on the local API (reqseq serve api), with the input as the JSON body; the answer is the output.

MCP

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