[bldr]docs
CLI toolsbldr

bldr workspace

Manage workspaces — directories containing `bldr-workspace.yml`

bldr workspace

Also ws.

Manage workspaces — directories containing bldr-workspace.yml.

The workspace is discovered by walking up from the current directory until bldr-workspace.yml is found; pass -W <PATH> to target a specific workspace instead.

bldr [BLDR FLAGS] ws <COMMAND>

bldr workspace add

Add a member to the workspace. Exactly one source is required. For --git / --container-image the member's content: is resolved from tracking: and both are written. Comments in the file are preserved

bldr [BLDR FLAGS] ws add [ADD FLAGS] <NAME>

<NAME>

Member name

Required.

--git <REPO>

Git repository (URL or path). The commit is resolved from the remote's default branch, or --git-branch

--git-branch <BRANCH>

Branch to track (with --git)

--container-image <IMAGE>

Container image reference (alternative to --git)

--container-tag <TAG>

Tag to track (with --container-image); defaults to latest

--path <PATH>

A watched workspace path

--blob <CID>

Content already addressed by a CID

bldr workspace deregister

Drop a workspace from the node's registry

bldr [BLDR FLAGS] ws deregister

bldr workspace init

Create a new workspace directory containing a default bldr-workspace.yml. Existing directories are accepted; an existing config file is never overwritten.

Creates in PATH (or -W &lt;PATH>, or the current directory).

bldr [BLDR FLAGS] ws init [PATH]

<PATH>

bldr workspace list

List all registered workspaces

bldr [BLDR FLAGS] ws list

bldr workspace member

Per-member edits against the parent snapshot: ws member &lt;NAME> &lt;verb>

bldr [BLDR FLAGS] ws member <NAME> <COMMAND>

<NAME>

Member name the verb applies to

Required.

bldr workspace member reset

Reset a member (or part of it) back to the inherited snapshot value. With no flag, drops the whole member override so it re-inherits

bldr [BLDR FLAGS] ws member <NAME> reset [RESET FLAGS]

--pin

Reset only the content override (revert to the inherited pin)

Defaults to false.

--tracking

Reset only the tracking override

Defaults to false.

--option <KEY>

Reset only this member option

bldr workspace member set

Set a member option (SetMemberOption)

bldr [BLDR FLAGS] ws member <NAME> set [SET FLAGS]

--option <KEY=VALUE>

Option as KEY=VALUE

Required.

bldr workspace member unset

Remove a member option (UnsetMemberOption)

bldr [BLDR FLAGS] ws member <NAME> unset [UNSET FLAGS]

--option <KEY>

Option key to remove

Required.

bldr workspace parent

Set or clear the parent snapshot (parent:) this workspace diffs over

bldr [BLDR FLAGS] ws parent <COMMAND>

bldr workspace parent set

Set the parent snapshot CID (parent:)

bldr [BLDR FLAGS] ws parent set <CID>

<CID>

CID of a WorkspaceRevisionSnapshot

Required.

bldr workspace parent unset

Clear the parent snapshot

bldr [BLDR FLAGS] ws parent unset

bldr workspace pending-changes

For each tracked member, ask its content-tracking-provider/&lt;kind> whether newer upstream content is available, and report whether each member is up to date, updatable, locally overridden, or untracked

bldr [BLDR FLAGS] ws pending-changes

bldr workspace pull

Re-resolve each named member's content: from its tracking: (in parallel) and write the updated content back to bldr-workspace.yml (comments preserved) — e.g. bldr ws pull build-controller to pick up a freshly-pushed image digest. With no members, pulls every tracked member

bldr [BLDR FLAGS] ws pull [MEMBER]...

<MEMBER>

Members to pull; empty pulls every tracked member

May be given more than once.

bldr workspace register

Tell the node about this workspace

bldr [BLDR FLAGS] ws register

bldr workspace reset

Reset a workspace option to the parent snapshot's value by dropping the local override (contrast with unset, which forces the option absent with a ~ tombstone even when the parent sets it)

bldr [BLDR FLAGS] ws reset <KEY>

<KEY>

Required.

bldr workspace rm

Remove a member (replaces it with a ~ tombstone)

bldr [BLDR FLAGS] ws rm <NAME>

<NAME>

Member name

Required.

bldr workspace sequences

The workspace's sequences (sequences:): named counters kept in the manifest as a versioning service. Each is an integer or a major.minor.build triple; bump hands out the next value

bldr [BLDR FLAGS] ws sequences <COMMAND>

bldr workspace sequences bump

Increment a sequence and print the new value. With no flag, --build: the last component, and the only one an integer sequence has

bldr [BLDR FLAGS] ws sequences bump [BUMP FLAGS] <NAME>

<NAME>

Sequence name

Required.

--build

Increment the build (last) component. The default

Defaults to false.

--minor

Increment minor and reset build to 0 (semver sequences only)

Defaults to false.

--major

Increment major and reset minor and build to 0 (semver sequences only)

Defaults to false.

bldr workspace sequences create

Create a sequence. The shape of INITIAL decides its kind: 0 (any integer) is a counter, 0.0.0 (three integers) a major.minor.build triple. Fails if the name is taken

bldr [BLDR FLAGS] ws sequences create <NAME> <INITIAL>

<NAME>

Sequence name

Required.

<INITIAL>

Initial value: an integer like 7, or major.minor.build like 1.2.0

Required.

bldr workspace sequences get

Show one sequence's value

bldr [BLDR FLAGS] ws sequences get <NAME>

<NAME>

Sequence name

Required.

bldr workspace sequences list

List every sequence with its value and kind

bldr [BLDR FLAGS] ws sequences list

bldr workspace sequences remove

Remove a sequence

bldr [BLDR FLAGS] ws sequences remove <NAME>

<NAME>

Sequence name

Required.

bldr workspace sequences set

Set a sequence to an exact value (the kind may change with it)

bldr [BLDR FLAGS] ws sequences set [SET FLAGS] <NAME>

<NAME>

Sequence name

Required.

--to <VALUE>

The new value: an integer, or major.minor.build

Required.

bldr workspace set

Set a workspace option (options: &#123; &lt;KEY>: &lt;VALUE> &#125;). VALUE is parsed as YAML, so it may be a scalar, list, or mapping (e.g. set targets '[app, bldr/ui]'). The reserved key build_controller selects the build controller

bldr [BLDR FLAGS] ws set <KEY> <VALUE>

<KEY>

Required.

<VALUE>

Required.

bldr workspace status

Show the current status of a workspace.

With --watch, streams live status updates until the workspace is deregistered or Ctrl-C is pressed.

bldr [BLDR FLAGS] ws status [STATUS FLAGS]

-w, --watch

Stream status changes instead of returning a single snapshot

Defaults to false.

bldr workspace unset

Remove a workspace option. build_controller is required to build, so unsetting it leaves the workspace unbuildable until it is set again

bldr [BLDR FLAGS] ws unset <KEY>

<KEY>

Required.

On this page