Checkouts | Wiele docs

A checkout is an ordinary local folder linked to one remote folder or file on one branch. Wiele keeps its state in a .wiele folder inside it. Commands that take --directory default to the current folder and also work from a subfolder. To keep files out of a checkout, see Ignore files.

wiele fetch

Fetch a file or folder into a new checkout directory.

wiele fetch [flags] <path> <destination>

Argument	Description
`<path>`	Remote path, such as `/notes/plan.md`, or `WORKSPACE:/path`.
`<destination>`	New folder for the checkout. It must not exist yet. To resume an interrupted fetch, run the same command again.

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`.
`--plan`	Print the file count and size without downloading.

wiele track

Connect an existing local folder to a remote folder, creating the remote folder if missing. Local files stay; push uploads them.

wiele track [flags] <path> <directory>

Argument	Description
`<path>`	Remote path, such as `/notes/plan.md`, or `WORKSPACE:/path`.
`<directory>`	Existing local folder. Its files stay where they are.

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`.
`--wait string`	How long to wait when the remote folder has to be created. Default: `30s`.

wiele status

Show local changes, the remote head, pending push or pull work and how to fix a stuck checkout.

wiele status [flags]

Flag	Description
`--directory string`	Checkout folder. Default: the current folder.
`--offline`	Report local state only, without contacting the server.

wiele diff

Compare local originals against their pinned baseline bytes.

wiele diff [flags]

Flag	Description
`--directory string`	Checkout folder. Default: the current folder.

wiele push

Capture and publish local changes. A repeat resumes the saved push; --abandon drops it; --delete approves missing tracked paths.

wiele push [flags]

Flag	Description
`--directory string`	Checkout folder. Default: the current folder.
`--message string`, `-m string`	Revision message. Default: `Update files`.
`--delete`	Approve deleting tracked files that are missing locally.
`--origin foreground\|live`	Who started the push. The background process passes `live`. Default: `foreground`.
`--abandon`	Cancel and drop the saved push instead of resuming it; files stay.
`--wait string`	How long to wait for the push to commit. Default: `30s`. On timeout, run `wiele push` again to resume.

wiele pull

Apply remote changes and retain displaced files for recovery. --keep-local keeps local edits that overlap remote changes.

wiele pull [flags]

Flag	Description
`--directory string`	Checkout folder. Default: the current folder.
`--keep-local`	Keep local edits to files that also changed remotely; save the remote versions for recovery.

wiele restore

Put a file's version from an earlier revision into the checkout. The file you replace goes to recovery. Push to commit the restore.

wiele restore [flags] <path>

Argument	Description
`<path>`	File path relative to the checkout folder, such as `notes/plan.md`.

Flag	Description
`--revision string`	Required. Revision SHA to restore from, from `wiele history`.
`--directory string`	Checkout folder. Default: the current folder.

wiele checkout list

List the checkouts on this machine and whether each folder still matches its record.

wiele checkout list [flags]

wiele checkout forget

Stop tracking this checkout. Preserve all working and recovery files; refuse unfinished operations.

wiele checkout forget [flags]

Flag	Description
`--directory string`	Checkout folder. Default: the current folder.

wiele checkout recover

Export local files, captures and recovery data, then release an interrupted pull. Review status before pushing.

wiele checkout recover [flags]

Flag	Description
`--directory string`	Checkout folder. Default: the current folder.
`--export-to string`	Required. New folder outside the checkout for the exported files.

Ignore files

status, push and live uploads skip files that match a rule in .wieleignore at the checkout's top folder. One glob pattern per line; lines starting with # are comments.

# editor and tool state
.obsidian/workspace.json
node_modules
*.tmp
!keep.tmp

A pattern without / matches a file or folder name anywhere. A pattern with / matches the path from the checkout's top folder.
A matching folder is skipped with everything inside it.
! in front of a pattern brings back what an earlier rule ignored. The last matching rule wins.
Files already in the checkout are never ignored. Delete them from Wiele first if you want them gone.
Wiele always skips .DS_Store, Thumbs.db, ~$* Office lock files, *.swp and *.swo, and never uploads .wieleignore itself, .wiele, .git, .gitattributes or .lfsconfig.