Reword ten sentences after rereading the last commit's prose

The last commit was not written on the model that
#397 requires. Every sentence it
added or changed was read again under that issue's rules and checked
against the code, as
#399 (comment) asks.

- The local index lists files too, so the README and the help text no
  longer say the file list is stored only in the snapshot's database.
- The root help lists the three commands that need the private key.
- The quoted-path, mode and rclone upload sentences now put the subject
  and verb early.
- `docs/REPOSTRUCTURE.md` names the path that `snapshot files` writes.
- The example config says what runs when the `snapshots` requirement is
  not met.
- "take that object for complete" becomes "treat that object as
  complete".

Model: fable-5-2
This commit is contained in:
sneak committed 2026-11-17 00:21:37 +00:00
1 parent 45d775709d
commit b2c8d75bcc
5 files changed
+25 -20

No files matched your search

+6 -2
View File
@@ -37,8 +37,12 @@ func NewRootCommand() *cobra.Command {
Short: "Secure incremental backup tool with asymmetric encryption",
Long: `vaultik is an incremental backup tool that encrypts data to age public
keys and uploads it to an S3-compatible object store, a local directory or
an rclone remote. The backed-up machine needs no private key: only
'snapshot files', 'snapshot restore' and 'snapshot verify --deep' need one.`,
an rclone remote. The backed-up machine needs no private key. Only these
commands need one:
snapshot files
snapshot restore
snapshot verify --deep`,
SilenceUsage: true,
// Bare 'vaultik' (no subcommand): print help. The banner is
// printed once at process startup by Entry, before cobra
+4 -4
View File
@@ -208,10 +208,10 @@ The snapshot may be named by its ID or, on a host with no local index,
by the remote key that 'snapshot list' prints for a remote-only snapshot
(an unambiguous leading part is enough).
The file list is only in the snapshot's encrypted database, so this
downloads and decrypts it. It requires the age private key, in the
VAULTIK_AGE_SECRET_KEY environment variable or as age_secret_key in the
config file; the environment variable wins.
The command reads the file list from the snapshot's encrypted database.
It downloads and decrypts that database. It requires the age private
key, in the VAULTIK_AGE_SECRET_KEY environment variable or as
age_secret_key in the config file; the environment variable wins.
Also needs permission to read the backup destination store, and to list
it when given a remote key, or a snapshot ID that is not in the local