autonote compares two snapshots and writes a generated note to the primary snapshot.
The generated note describes the change from the secondary snapshot to the primary snapshot.
Usage
rinne autonote --primary <id|@N> --secondary <id|@N> [--space <space> | --p-space <space> --s-space <space>] [--format standard|detail] [--append | --replace | --overwrite]
Options
--primary <id|@N>
Select the primary snapshot. This snapshot receives the generated note.
--secondary <id|@N>
Select the secondary snapshot used as the comparison base.
--space <space>
Resolve both snapshots in the same space.
--p-space <space>
Resolve the primary snapshot in this space.
--s-space <space>
Resolve the secondary snapshot in this space.
--format standard|detail
Choose the note format. The default is standard. detail adds per-file sections and also lists files whose content is unchanged but mtime changed.
--append
Append a new AutoNote block to the existing note. This is the default write mode.
--replace
Replace the latest AutoNote block if one exists. If no AutoNote block exists, append a new one.
--overwrite
Overwrite the entire note with the generated AutoNote content.
Examples
Write a standard note for the latest snapshot
rinne autonote --primary '@0' --secondary '@1' Write a detailed note
rinne autonote --primary '@0' --secondary '@1' --format detail Replace the latest AutoNote block
rinne autonote --primary '@0' --secondary '@1' --replace Overwrite the entire note
rinne autonote --primary '@0' --secondary '@1' --overwrite Resolve both snapshots in one space
rinne autonote --primary '@0' --secondary '@1' --space main Compare snapshots across spaces
rinne autonote --primary '@0' --secondary '@0' --p-space main --s-space experiment
Notes
- Standard only.
- The note is written to the primary snapshot note.md.
- With --format detail, AutoNote includes an Mtime changed files section for content-identical files whose mtime changed.
- PowerShell users should quote @N selectors, for example rinne autonote --primary '@0' --secondary '@1'.
- --space cannot be combined with --p-space or --s-space.
- --append, --replace, and --overwrite are mutually exclusive.
- The . working-folder selector is not supported by autonote.