CLI Commands

One-page index of Rinne CLI commands. Each command links to its own reference page.

Run rinne <command> --help for command-specific usage.

If you want to understand Rinne's .rinne folder layout, see Layout.

Need to exclude build outputs or caches? See Ignore.

When a command fails, see Errors.

  • init /docs/v092/cli/commands/init/
    Initialize a Rinne workspace in the current directory.
  • config /docs/v092/cli/commands/config/
    Show/init/set .rinne/config.json (defaultParallelism, zstdLevel).
  • save /docs/v092/cli/commands/save/
    Create a snapshot in the current workspace.
  • history /docs/v092/cli/commands/history/
    List/show/resolve snapshot history under .rinne/snapshots/<space>/.
  • space /docs/v092/cli/commands/space/
    List/create/use/rename/current/delete spaces under .rinne/snapshots/<space>/.
  • note /docs/v092/cli/commands/note/
    List/show/edit snapshot notes.
  • diff /docs/v092/cli/commands/diff/
    Show diff between two snapshots, or snapshot vs working folder.
  • verify /docs/v092/cli/commands/verify/
    Verify snapshot integrity for a selected snapshot.
  • validate /docs/v092/cli/commands/validate/
    Validate snapshot content against stored hashes.
  • extract /docs/v092/cli/commands/extract/
    Extract a selected snapshot into an external output directory.
  • restore /docs/v092/cli/commands/restore/
    Restore the working directory to the selected snapshot state.
  • fuse /docs/v092/cli/commands/fuse/
    Fuse two CAS snapshots into a new snapshot (ManifestDB).
  • delete /docs/v092/cli/commands/delete/
    Delete a snapshot and its manifest-db entry. This command does not delete CAS chunk files.
  • gc /docs/v092/cli/commands/gc/
    Garbage-collect unreachable CAS objects and maintain cache DBs.

Early Access note: flags and outputs may change between versions.