Skip to content

docs: Distinguish chosen backup identifiers #178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
BenWestgate wants to merge 1 commit into from
Draft

docs: Distinguish chosen backup identifiers #178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/user/guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,8 @@ Choose one command:
copies, but any copy can recover the seed.
- **Custom:** thresholds 4 through 9 require `--shares` or `--indices`. For
example, `ms32 create 4cash --shares 7` produces seven `cash` shares; any
four recover the seed.
four recover the seed. The identifier tells backups apart, so choose one
that no other backup you keep uses.

More required shares make theft harder; fewer required shares make recovery
easier.
Expand Down
2 changes: 1 addition & 1 deletion src/codex32/_cli_parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ def parser(prog: str = "codex32", *, master_seed: bool = False) -> argparse.Argu
"header",
nargs="?",
metavar="HEADER",
help="backup header or sharing threshold, such as 3cash or 3; omit for a single recovery card",
help="sharing threshold, such as 3, or threshold and identifier, such as 3cash, using an identifier no other backup you keep uses; omit for a single recovery card",
)
create.add_argument(
"--bytes",
Expand Down
Loading