Andy DixonandClaude
53968f8822
README, CLAUDE.md, man pages, the user guide and its screenshot script now describe the Rust build and the intentional behaviour changes, which docs/MIGRATION.md lists. Go and Rust micro-benchmarks for the same operations, and scripts/bench.sh for end-to-end comparison. build.sh exports its tree root to the per-target jobs and keeps logs out of the output directory; riscv64 musl builds use getrandom's raw syscall backend, since zig's musl getrandom never reaches the kernel there. Co-Authored-By: Claude <noreply@anthropic.com>
67 lines
2.2 KiB
Groff
67 lines
2.2 KiB
Groff
.TH VAULT-ADD 1 "October 2026" "vault" "User Commands"
|
|
.SH NAME
|
|
vault-add \- encrypt files, directories or URLs into the vault
|
|
.SH SYNOPSIS
|
|
.B vault add
|
|
.RB [ \-\-key
|
|
.IR PATH ]
|
|
.RB [ \-\-vault
|
|
.IR DIR ]
|
|
.RB [ \-\-max\-bytes
|
|
.IR SIZE ]
|
|
.RB [ \-\-timeout
|
|
.IR DURATION ]
|
|
.IR FILE | DIR | URL
|
|
.RI [ FOLDER ]
|
|
.SH DESCRIPTION
|
|
Encrypts a file into the vault, named after its base name. A directory is
|
|
added recursively, keeping its structure beneath its own name; a directory
|
|
named "." or ".." adds its contents directly. Non-regular files, the vault
|
|
and the key are skipped. A stored name that already exists is replaced.
|
|
.PP
|
|
An \fBhttp://\fR or \fBhttps://\fR \fIURL\fR is downloaded with a Chrome user
|
|
agent and stored under the last element of its final (post-redirect) path, or
|
|
the host name if there is none. Only a 200 response is accepted. Certificates
|
|
are always verified; at most 10 redirects are followed, to http or https
|
|
only. The download is staged in a private temporary file (it must be
|
|
complete before it can be stored), which is removed afterwards whatever
|
|
happens; it is plaintext on disk meanwhile.
|
|
.PP
|
|
A file that changes while it is being added (it grows, shrinks, or is
|
|
replaced) is not stored, and the command fails.
|
|
.PP
|
|
\fIFOLDER\fR places the result inside a folder in the vault. File contents
|
|
are cut into 4 MiB chunks, the last bucket-padded.
|
|
.SH OPTIONS
|
|
.TP
|
|
.BI \-\-key " PATH"
|
|
Key file. Default: $VAULT_KEY, else ~/.vault/key.
|
|
.TP
|
|
.BI \-\-vault " DIR"
|
|
Vault directory. Default: $VAULT_DIR, else ~/.vault/store.
|
|
.TP
|
|
.BI \-\-max\-bytes " SIZE"
|
|
Largest download accepted, counted after decompression, such as 500M or 50G.
|
|
Default 16G; at most 1T.
|
|
.TP
|
|
.BI \-\-timeout " DURATION"
|
|
Deadline for the whole download, such as 30m. Default 2h. Connecting must
|
|
take under 30 seconds and the response headers must arrive within a minute.
|
|
.SH ENVIRONMENT
|
|
.TP
|
|
.B VAULT_PASSPHRASE
|
|
Passphrase, instead of prompting on the terminal.
|
|
.SH EXAMPLES
|
|
.nf
|
|
vault add report.pdf work/2026
|
|
vault add ./photos
|
|
vault add https://example.com/paper.pdf papers
|
|
.fi
|
|
.SH SEE ALSO
|
|
.BR vault (1),
|
|
.BR vault\-migrate (1),
|
|
.BR vault\-mirror (1),
|
|
.BR vault\-absorb (1)
|
|
.SH AUTHOR
|
|
Andy Dixon <vault@dixon.cx>, https://www.dixon.cx
|