docs: split README into topic docs, replace Homebrew with binary install - #4
Conversation
wirwolf
commented
Sep 15, 2026
wirwolf
commented
- Move full command reference into docs/commands.md, grouped by area, and document previously-undocumented commands (status, init, seal, unseal, rekey, local, logout, renew, uuid, dhparam, undelete, revert, ask, exists, versions, ls, option, vault, curl, x509 reissue/show, target delete).
- Move sync (pull/plan/apply) and the local JSON file format into docs/sync.md as general functionality, independent of Docker.
- Move Docker usage examples into docs/docker.md.
- Replace the outdated Homebrew instructions in README with binary download examples (curl/wget/PowerShell) and a short Docker snippet, and drop the stale Slack link.
- Move full command reference into docs/commands.md, grouped by area, and document previously-undocumented commands (status, init, seal, unseal, rekey, local, logout, renew, uuid, dhparam, undelete, revert, ask, exists, versions, ls, option, vault, curl, x509 reissue/show, target delete). - Move sync (pull/plan/apply) and the local JSON file format into docs/sync.md as general functionality, independent of Docker. - Move Docker usage examples into docs/docker.md. - Replace the outdated Homebrew instructions in README with binary download examples (curl/wget/PowerShell) and a short Docker snippet, and drop the stale Slack link.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 05783a2da0
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| directly or via Docker, see [docker.md](docker.md) for container examples). | ||
| It synchronizes secrets between Vault and a local directory of JSON files, | ||
| which is useful for reviewing changes before they're applied, or for | ||
| managing secrets under version control / GitOps-style workflows. |
There was a problem hiding this comment.
When users follow this GitOps recommendation, sync pull writes the actual Vault values as ordinary, unencrypted JSON files, including credentials such as the password shown later in this document. Committing that directory therefore exposes secrets permanently in repository history; recommend version control only with a documented encryption workflow, or explicitly warn users to exclude the generated files.
Useful? React with 👍 / 👎.
The combined "macOS (Intel) / Linux" wget snippet fetched vault-manager-darwin-amd64.tar.gz, so on Linux the extracted Mach-O binary would not run. Split into separate Linux (linux-amd64) and macOS Intel (darwin-amd64) examples, each using its own release asset.
The uuid command takes a single PATH[:KEY] argument; the example passed path and key as two separate positional args, which the handler rejects with a usage error before ever reaching Vault.
2 participants
