Initialise workspace

Create a workspace with the standard model in an existing folder.

Command workspace.init. Writes files in the working tree, never to Git. It also runs while the workspace is read-only. Creates the workspace, so there is no metamodel yet that could make it read-only.

Input

Field	Type	Required	Description
`path`	`localPath`	yes	Existing folder; must not contain reqseq-workspace.yaml or the metamodel file.
`name`	`string`	yes
`metamodel`	`object`	no
`metamodel.repository`	`string`	no
`metamodel.path`	`string`	no

Output

Field	Type	Required	Description
`files`	array of `string`	yes
`problems`	array of `problem`	no

App

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

CLI

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

Usage: reqseq workspace init <path> <name> [options]

Create a workspace with the standard model in an existing folder.

Arguments:
  path                    Existing folder; must not contain
                          reqseq-workspace.yaml or the metamodel file.
  name

Options:
  --path <value>          instead of the argument <path>
  --name <value>          instead of the argument <name>
  --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: metamodel

API

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

MCP

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