init

Initialize a Rinne workspace in the current directory.

Back to CLI Commands

Use init once at the root of a folder you want Rinne to track.

It creates the .rinne directory, writes a default rinneignore.json when missing, and sets up the current-space file for the default space.

Starting with v0.9.8, new repositories use storage format v2 (pack files) by default. Use --format v1 when the repository must stay readable by Rinne v0.9.7.

Usage
rinne init
rinne init --format <v1|v2>
Options
--format <v1|v2>
Storage format for a new repository. v2 (default) stores chunks in pack files. v1 stores each chunk as its own file and is compatible with Rinne v0.9.7.
Examples
Initialize the current folder as a Rinne workspace (format v2)
rinne init
Initialize a repository that Rinne v0.9.7 can also open
rinne init --format v1
Notes
  • Run this from the workspace root you want to manage.
  • If .rinne already exists, init fills in missing files but does not turn the command into a history rewrite. It does not change the format of an existing repository; use upgrade or downgrade for that.
  • When a new format v2 repository is created, init prints an extra Format line as a reminder that Rinne v0.9.7 cannot open it.
  • Typical next steps are rinne config show and then rinne save.