CLI reference / Remote files

CLI reference

Remote files

Read and write workspace files without a checkout: stat, ls, entries, get, read, write, history and revision.

These commands work on the server copy. Nothing is downloaded into a checkout, and you can run them from any folder. Paths take the form WORKSPACE:/path, or a plain path with --workspace or inside a checkout.

read and write suit small text files and agents without a checkout. Files over 512 KiB, and larger changes, go through checkouts.

wiele stat

Inspect one remote file or folder in an explicit workspace and branch.

wiele stat [flags] <path>
Argument Description
<path> Remote path, such as /notes/plan.md, or WORKSPACE:/path.
Flag Description
--workspace string Workspace ID, slug or name. Not needed inside a checkout or when the path is written as WORKSPACE:/path.
--branch string, --copy string Branch name or ID. --copy is the same flag. Default: the checkout's branch, otherwise main.
--revision string Full 40-character revision SHA to read instead of the branch head.
--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 ls

List one page of authorized files and folders.

wiele ls [flags] <path>
Argument Description
<path> Remote path, such as /notes/plan.md, or WORKSPACE:/path.
Flag Description
--workspace string Workspace ID, slug or name. Not needed inside a checkout or when the path is written as WORKSPACE:/path.
--branch string, --copy string Branch name or ID. --copy is the same flag. Default: the checkout's branch, otherwise main.
--revision string Full 40-character revision SHA to read instead of the branch head.
--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 Entries per page, at most 1,000. Default: 50.

wiele entries

List where you can start browsing a workspace: its root, or the folders and files shared with you.

wiele entries [flags] <workspace>
Argument Description
<workspace> Workspace written as WORKSPACE:/, such as my-work:/.
Flag Description
--workspace string Workspace ID, slug or name. Not needed inside a checkout or when the path is written as WORKSPACE:/path.
--branch string, --copy string Branch name or ID. --copy is the same flag. Default: the checkout's branch, otherwise main.
--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 get

Download verified original bytes to a new local file.

wiele get [flags] <path> <destination>
Argument Description
<path> Remote path, such as /notes/plan.md, or WORKSPACE:/path.
<destination> New local file to write. The command refuses to overwrite one.
Flag Description
--workspace string Workspace ID, slug or name. Not needed inside a checkout or when the path is written as WORKSPACE:/path.
--branch string, --copy string Branch name or ID. --copy is the same flag. Default: the checkout's branch, otherwise main.
--revision string Full 40-character revision SHA to read instead of the branch head.
--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 read

Read a file's content, or a folder's entries and contents, at one revision in one call.

wiele read [flags] <path>
Argument Description
<path> Remote path, such as /notes/plan.md, or WORKSPACE:/path.
Flag Description
--workspace string Workspace ID, slug or name. Not needed inside a checkout or when the path is written as WORKSPACE:/path.
--branch string, --copy string Branch name or ID. --copy is the same flag. Default: the checkout's branch, otherwise main.
--revision string Full 40-character revision SHA to read instead of the branch head.
--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.
--depth integer How many folder levels to read, 1 to 64. Default: 1.
--exclude string Path or folder to skip. Repeat for up to 20.
--no-content List entries without their contents.
--encoding auto|base64 auto returns UTF-8 text as text and other bytes as base64; base64 returns everything as base64. Default: auto.
--since string For a folder, return only what changed after this revision and the paths it removed.
--cursor string Cursor from the previous page's output.
--limit integer Entries per page, at most 1,000. Default: 500.

wiele write

Write or delete remote paths in one revision, refused when a path no longer matches.

wiele write [flags] <path>
Argument Description
<path> Remote path, such as /notes/plan.md, or WORKSPACE:/path.
Flag Description
--workspace string Workspace ID, slug or name. Not needed inside a checkout or when the path is written as WORKSPACE:/path.
--branch string, --copy string Branch name or ID. --copy is the same flag. Default: the checkout's branch, otherwise main.
--revision string Full 40-character revision SHA to read instead of the branch head.
--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.
--from string Local file to write, or - for standard input.
--delete Delete the path instead of writing it.
--if-sha256 string Write only if the file's current SHA-256 is this hash.
--if-absent Write only if nothing exists at the path.
--if-revision string Write only if the path has not changed since this revision.
--expected-head string Write only if the branch head is this revision.
--message string, -m string Revision message.
--request string JSON write request with several writes and deletes.
--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 history

Read a resource's first-parent history, including deleted versions.

wiele history [flags] <resource>
Argument Description
<resource> Resource ID of the file or folder, from wiele stat.
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.
--branch string, --copy string Branch name or ID. --copy is the same flag. Default: the checkout's branch, otherwise main.
--head string Pin paging to this head revision.
--after string Page after this revision, from the previous page.

wiele revision show

Show one revision: when it was made, its parents and the changed paths.

wiele revision show [flags] <revision> [<other-revision>]
Argument Description
<revision> Revision SHA.
<other-revision> Optional. Leave it out: show takes one revision.
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.
--branch string, --copy string Branch name or ID. --copy is the same flag. Default: the checkout's branch, otherwise main.

wiele revision diff

List the paths that changed between two revisions.

wiele revision diff [flags] <revision> [<other-revision>]
Argument Description
<revision> Earlier revision SHA.
<other-revision> Optional. Later revision SHA.
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.
--branch string, --copy string Branch name or ID. --copy is the same flag. Default: the checkout's branch, otherwise main.

Write requests

write --request FILE takes a JSON file with several writes and deletes, committed as one revision. Each entry needs a precondition in expected, unless the request gives baseRevisionSha or expectedHeadSha:

{
  "message": "Update notes",
  "writes": [
    { "path": "notes/a.md", "content": "Hello\n", "expected": { "kind": "absent" } },
    {
      "path": "notes/b.md",
      "content": "Updated\n",
      "expected": { "kind": "sha256", "sha256": "HASH" }
    }
  ],
  "deletes": [{ "path": "notes/old.md", "expected": { "kind": "revision", "revisionSha": "SHA" } }]
}

A write changes at most 100 paths, 512 KiB per file and 1 MiB per request. Binary content goes in with "encoding": "base64".