Commit Graph
9 Commits
Author SHA1 Message Date
clawbot f65fd2870b Fix three review findings in help text, example config and terms
check / check (push) Successful in 12m37s
The snapshot restore help splits its 40-word permissions sentence in
two. The snapshot-ID case leaves the parenthesis, and the temporary
space requirement gets its own sentence.

configs/config.example.yml gains a commented-out env entry, after
hostname, so its first line, which says the file shows every option,
is true again.

docs/REPOSTRUCTURE.md defines remote key in Terms, before the
marker-file section uses it.

Model: fable-5-1
2026-11-11 07:55:31 +00:00
sneak a0efb2a5bc Update the rewritten documents for the fixes merged into next
The documents, the example config and the help text are rebased onto the
fourteen fixes on next. The sentences those fixes made false now match the
code: an unknown config key, a relative index_path and a value that is not a
size are refused when the config loads; a backup saves the destination in the
local index only after it writes the marker file, and no other command saves
it; a backup skips the local index, its side files and the lock file; a binary
from go install reports its tag and counts as a release; a declined deletion
prompt exits 1 with "deletion not confirmed"; the S3 keys are set before an
s3:// storage_url. No document quoted the old messages for an unknown snapshot
ID, a wrong private key or an unreadable blob.

Model: fable-5-1
2026-11-11 07:01:54 +00:00
sneak 7743ec621e Define rclone's remote where it is first used
The documents use "remote key" for something else, so "remote" as
rclone's noun is now defined on first use: a remote is a storage service
set up in rclone. Changed in `README.md` (the destination bullet),
`docs/REPOSTRUCTURE.md` (the opening) and `config.example.yml` (the
`storage_url` comment).

Model: fable-5-1
2026-11-11 07:01:54 +00:00
clawbot 92928c86d4 Read all five documents against the code and fix what the sixth review found
Fixes the four findings of the sixth review: `snapshot remove` with
`--local-only`, the two comma-chained permission lists, six undefined terms,
and the sentence about an unfinished snapshot in the local index.

Then reads every sentence of `README.md`, `ARCHITECTURE.md`,
`docs/DATAMODEL.md`, `docs/REPOSTRUCTURE.md` and the comments in
`config.example.yml` against the code for four faults: a command's needs or
behaviour stated without regard to a flag, a false absolute, three or more
things chained with commas, and a technical word not defined on first use.
Each sentence changed is listed on the pull request.

The help string of `snapshot remove --dry-run` now says it needs no
permission to delete.

Model: fable-5-1
2026-11-11 07:01:54 +00:00
sneak 72ea483312 Say which commands need the private key, in README.md and config.example.yml
The last sentence of "The private key" and the matching comment in
config.example.yml named only the restore machine. snapshot verify --deep
needs the key too. Both now name both commands. The "Everyday use" block
gains a comment saying its next three commands run on a machine that holds
the private key.

Model: fable-5-1
2026-11-11 07:01:54 +00:00
sneak 536ee8bb75 Fix the review findings in --help and config.example.yml
snapshot list says why a remote-only snapshot is listed by its remote
key. snapshot verify says what access to the destination it needs. The
note on the age-keygen file is two sentences in snapshot verify and
snapshot restore. remote nuke says "backup destination store".

config.example.yml names the commands that run without a snapshot.

Only help strings and comments change.

Model: fable-5-1
2026-11-11 07:01:54 +00:00
sneak 871cef1284 Say what each command needs in --help and config.example.yml
snapshot verify --help now says --deep needs the age private key, from
VAULTIK_AGE_SECRET_KEY or age_secret_key, as snapshot restore does.
Both now name the config key as well as the environment variable.

The help of snapshot create, list, purge, remove, prune, remote info
and remote nuke says which access to the destination it needs.
config.example.yml gains age_secret_key, and no longer tells the reader
to pipe age-keygen into grep, which discards the private key.

Only help strings and comments change.

Model: fable-5-1
2026-11-11 07:01:54 +00:00
clawbot f6df500ba2 Refuse a relative index_path (closes #430)
check / check (push) Successful in 10m28s
A relative index_path, or VAULTIK_INDEX_PATH, was accepted and resolved against whatever directory vaultik ran in. Loading the config now refuses a relative or empty value, quoting it, with the same wording as the file:// check; ~ is still expanded first.

Model: opus-5-5
2026-11-11 06:06:54 +01:00
clawbot aae7fa17ae Format Markdown with prettier and move documents out of the root (closes #411)
check / check (push) Successful in 13m11s
REPO_POLICIES.md names prettier as the Markdown formatter and keeps documents out of the root. script/fmt and script/fmt-check now run prettier over all Markdown (4-space indents, proseWrap always) besides gofmt, with node and yarn installed by script/bootstrap as in sneak/prompts. All Markdown is reformatted with no text change. ARCHITECTURE.md and TODO.md move to docs/, config.example.yml to configs/, and every reference follows.

Model: opus-5-5
2026-11-10 23:22:31 +01:00