CLI reference / Workspaces

CLI reference

Workspaces

wiele workspace: create, list, share, archive and inspect workspaces.

A workspace is one versioned tree of files inside an organization. Paths inside it are written as WORKSPACE:/path, where WORKSPACE is the workspace's slug, name or ID.

wiele workspace create

Create a workspace and wait until it is ready, as an organization owner or admin. The organization needs a subscription or trial in good standing.

wiele workspace create [flags] <name>
Argument Description
<name> Workspace name, such as My work.
Flag Description
--slug string Short name used in paths such as my-work:/. Default: the name in lowercase ASCII.
--visibility private|public public lets every organization member read it; private limits it to people with a grant.
--member-access read|write For a public workspace, whether members can read or also write.
--org string Organization ID or slug. Default: the checkout's organization when the workspace comes from the checkout, otherwise the one picked with wiele org use.
--idempotency-key string UUIDv7 that makes the request safe to retry. Each run generates one; pass the same key to replay a request after a timeout.
--wait string How long to wait for the operation to finish, such as 30s or 2m, from 0ms to 24h. Default: 30s.
--no-wait Return as soon as the server accepts the request.

wiele workspace list

List the organization's workspaces you can see.

wiele workspace list [flags]
Flag Description
--org string Organization ID or slug. Default: the checkout's organization when the workspace comes from the checkout, otherwise the one picked with wiele org use.
--cursor string Cursor from the previous page's output.
--limit integer Maximum number of entries per page. Default: 100.

wiele workspace show

Show one workspace, including its initialization state and version.

wiele workspace show [flags] <workspace>
Argument Description
<workspace> Workspace ID, such as ws_..., from wiele workspace list. This command does not look up names or slugs.
Flag Description
--org string Organization ID or slug. Default: the checkout's organization when the workspace comes from the checkout, otherwise the one picked with wiele org use.

wiele workspace visibility

Make a workspace public, so every organization member can read it or, with --member-access write, change it, or private, so only people with a grant can.

wiele workspace visibility [flags] <visibility>
Argument Description
<visibility> public or private.
Flag Description
--workspace string Required. Workspace ID, such as ws_..., from wiele workspace list. This command does not look up names or slugs.
--org string Organization ID or slug. Default: the checkout's organization when the workspace comes from the checkout, otherwise the one picked with wiele org use.
--member-access read|write For public, whether members can read or also write. Default: read.
--epoch integer Required. The organization's current policy epoch, from wiele org show or wiele access show. Read it again after any access change.
--idempotency-key string UUIDv7 that makes the request safe to retry. Each run generates one; pass the same key to replay a request after a timeout.

wiele workspace archive

Archive a workspace, as an organization owner or admin or an admin of the workspace. Members lose access to its files.

wiele workspace archive [flags]
Flag Description
--workspace string Required. Workspace ID, such as ws_..., from wiele workspace list. This command does not look up names or slugs.
--org string Organization ID or slug. Default: the checkout's organization when the workspace comes from the checkout, otherwise the one picked with wiele org use.
--epoch integer Required. The organization's current policy epoch, from wiele org show or wiele access show. Read it again after any access change.
--idempotency-key string UUIDv7 that makes the request safe to retry. Each run generates one; pass the same key to replay a request after a timeout.

wiele workspace usage

Inspect workspace storage and backup coverage as an organization admin.

wiele workspace usage [flags]
Flag Description
--workspace string Workspace ID, slug or name. Not needed inside a checkout or when the path is written as WORKSPACE:/path.
--org string Organization ID or slug. Default: the checkout's organization when the workspace comes from the checkout, otherwise the one picked with wiele org use.

wiele workspace retry

Resume initialization. Exhausted Git sends allow observation only; exhausted provisioning receives five further attempts.

wiele workspace retry [flags] <workspace>
Argument Description
<workspace> Workspace ID, such as ws_..., from wiele workspace list. This command does not look up names or slugs.
Flag Description
--org string Organization ID or slug. Default: the checkout's organization when the workspace comes from the checkout, otherwise the one picked with wiele org use.
--expected-version integer Required. The workspace's current version, from wiele workspace show.
--reason string Required. Why you retry, kept in the audit log.
--idempotency-key string UUIDv7 that makes the request safe to retry. Each run generates one; pass the same key to replay a request after a timeout.
--wait string How long to wait for the operation to finish, such as 30s or 2m, from 0ms to 24h. Default: 30s.
--no-wait Return as soon as the server accepts the request.

wiele workspace backup show

Show the backup state of one stored file version.

wiele workspace backup show [flags] <oid>
Argument Description
<oid> Content OID: the 64-character SHA-256 of the file version.
Flag Description
--workspace string Workspace ID, slug or name. Not needed inside a checkout or when the path is written as WORKSPACE:/path.
--org string Organization ID or slug. Default: the checkout's organization when the workspace comes from the checkout, otherwise the one picked with wiele org use.

wiele workspace backup retry

Resume an original backup after its retry budget is exhausted.

wiele workspace backup retry [flags] <oid>
Argument Description
<oid> Content OID: the 64-character SHA-256 of the file version.
Flag Description
--workspace string Workspace ID, slug or name. Not needed inside a checkout or when the path is written as WORKSPACE:/path.
--org string Organization ID or slug. Default: the checkout's organization when the workspace comes from the checkout, otherwise the one picked with wiele org use.
--expected-attempts integer Required. The backup's current attempt count, from wiele workspace backup show.
--reason string Required. Why you retry, kept in the audit log.
--idempotency-key string UUIDv7 that makes the request safe to retry. Each run generates one; pass the same key to replay a request after a timeout.

wiele workspace retention is on the retention page.