Page kind: Reference
swarmops ws materialize#
Write out more of a workspace's tree: the paths join its prefixes.
The .gitignore and .swarmignore files of the directories above each path join too. A path the tree lacks joins as it is, nothing written, when it is on disk and its parent is the root, a directory of the tree or one above a prefix: a new file the hint of E_WS_OUTSIDE_PREFIXES names. Else it is E_PATH_NOT_FOUND.
- Group
workspaces- Since
0.3.0- Mutates
- yes
- Identity required
- no
- MCP tool
ws_materialize- Envelope op
ws_materialize- Exit codes
- 0
- Errors
- none
Syntax#
swarmops ws materialize [OPTIONS] <PATH>...Required arguments#
Syntax: <PATH>.
The repository paths to write out.
Optional arguments#
The command also takes the global options.
Syntax: --ws <NAME>.
The workspace, by its name in the store's registry (default: the one around the working directory).
Syntax: --ws-path <DIR>.
The workspace's directory.
Syntax: --status-after <STATUS_AFTER>.
Default: page.
page: the first page of the status follows the result; none: it is left out. Values: page: The first page of the status; none: No status.
Examples#
No recorded example yet.
No recorded example yet.
Return information#
result is a WsMaterializeResp (swarmops schema WsMaterializeResp prints its JSON Schema).
| Field | Type | Required | Description |
|---|---|---|---|
bytes | integer | yes | How many bytes were written. |
materialized | array of string | yes | The prefixes added. |
status_after | WsStatus or null | no | The status after the mutation; omitted when the request said none. |
Envelope op: ws_materialize.
Exit codes:
0: Success.
Errors#
No golden step shows this command failing yet.
Any command that opens a store may also fail with a store error, such as E_NOT_A_REPO, E_IO or E_STORE_CORRUPT; a command line the grammar refuses is E_INVALID_ARG (exit 2).