rimba archive

Archive a worktree by removing its directory but preserving the local branch. The branch can later be restored with rimba restore.

Archiving is useful when you need to pause a task and reclaim disk space without losing work.

Synopsis

rimba archive <task> [flags]

Examples

rimba archive my-feature
rimba archive my-feature -f      # Force archival even if dirty
rimba archive my-feature --dry-run

Common workflows

Pause a task to free disk space

rimba archive big-refactor
# Worktree directory removed; branch preserved locally
# Use 'rimba list --archived' to see archived branches

Force-archive a dirty worktree

rimba archive wip-spike --force
# Commits are preserved in the branch; uncommitted changes are lost

The branch is preserved locally. Use rimba restore to recreate the worktree from the archived branch.

Flags

Flag Description
-f, --force Force archival even if the worktree has uncommitted changes
--dry-run Preview what would be archived without making changes
  • rimba restore · recreate a worktree from an archived branch
  • rimba remove · remove both worktree and branch permanently
  • rimba list · use --archived to see archived branches

This site uses Just the Docs, a documentation theme for Jekyll.