Skip to content

Show workspace status

Repositories of the workspace, which are available, where the metamodel comes from, read-only state.

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

No input.

Field Type Required Description
name string yes
repositories array of object yes
repositories[].name string yes
repositories[].available boolean yes
repositories[].path string no
repositories[].commit commit no Full Git object ID (SHA-1 or SHA-256).
repositories[].readOnly boolean no ReqSeq cannot write the repository folder itself (read-only file system or no write permission). Reading works as usual and the workspace stays writable; writes into this repository are refused with file.read-only (SR-018 AK2). Rights on the Git server are not visible here (D-016, D-024). Only for available repositories; left out where the operating system cannot tell (Windows).
metamodel object yes
metamodel.repository string yes
metamodel.path string yes
metamodel.valid boolean yes
readOnly boolean yes
problems array of problem no

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

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

Usage: reqseq workspace status [options]
Repositories of the workspace, which are available, where the metamodel comes
from, read-only state.
Options:
--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

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

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