Repository navigation
Document the privacycommand CLI and how to install it - #10
Merged
Merged
Conversation
The CLI was renamed from auditctl to privacycommand and now ships inside the app (privacykey/privacycommand#28). The docs still said it had to be built from source. - auditctl.mdx becomes cli.mdx ("Command line"), with a redirect from /auditctl. It covers the Homebrew install, the app menu's Install Command Line Tool… (and its sudo fallback and safety rules), building from source for 0.1.5 and earlier, usage with the new name, and the audit exit codes. - Every page that ran `swift run -c release auditctl …` or linked /auditctl now uses `privacycommand …` and /cli. - Installation and Updating mention the tool, Troubleshooting gains "command not found" and "asks you to move the app" entries, and the Develop pages use the new target names and the embed phase. - llms.txt and llms-full.txt regenerated. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
docs-privacycommand | 44a16fc | Commit Preview URL Branch Preview URL |
Oct 09 2026, 02:10 AM |
Documents `privacycommand completion <zsh|bash|fish>` (privacykey/privacycommand#29): what completes, that Homebrew sets it up, the one line per shell otherwise, and a zsh troubleshooting entry (compinit order, Homebrew's fpath, a stale ~/.zcompdump). llms files regenerated. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The CLI on main gained `upgrade`, a `--max-risk` gate, `--greedy` and .pkg artifact support, so cli.mdx's "`.pkg` is skipped" and "will not upgrade anything" were no longer the whole story. - cli.mdx: preview's new flags, the casks and formulae it lists but can't analyse, the brew calls it makes now, exit code 3, .pkg handling, and a new "Upgrading within a risk limit" section (cleared/held, --dry-run, --no-input, exit codes 0/1/2/3, the daily alias). - Security lists `brew upgrade` as the sixth outbound call; the Introduction and FAQ follow. - llms files regenerated. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The CLI was renamed from
auditctltoprivacycommandand now ships inside the app (privacykey/privacycommand#28). These docs still said it isn't in the DMG and had to be built and run withswift run -c release auditctl.What changes
auditctl.mdx→cli.mdx("Command line"). Aredirectsentry indocs.jsonsends/auditctlto/cli. The page now covers:/usr/local/bin. That covers thesudocommand it offers when the folder isn't writable, the Uninstall item, and what it refuses to touch.preview, all with the new name, plus a new table of audit exit codes (0/1/2/4, checked againstAuditCommand.swift).Cross-references. Introduction, Reports, Security, Compare runs, Batch scan, FAQ and About these docs link
/cliand useprivacycommand ….Tab completion (second commit):
cli.mdxgains a section onprivacycommand completion <zsh|bash|fish>, covering what completes, that Homebrew sets it up, and the one line per shell otherwise. Troubleshooting gains a zsh entry (compinit order, Homebrew'sfpath, a stale~/.zcompdump). This documents privacykey/privacycommand#29, so merge that before the next app release, or hold this section back.Installation gets a short "Command-line tool" section.
Updating notes that
--versionmatches the app and that the tool updates with it.Troubleshooting renames its section to "Command line" and adds two entries: "command not found" and "asks you to move the app".
Develop pages use the new target names (
privacycommandCLI/privacycommandCLIKit),.build/debug/privacycommand, and mention the Embed command-line tool build phase.llms.txt/llms-full.txtare regenerated.upgrade,--max-risk,--greedyand.pkg(third commit, after mergingmain). The CLI on privacycommandmaingained these, socli.mdx's ".pkgis skipped" and "will not upgrade anything" were out of date. The page now covers:preview's new flags and the casks and formulae it lists but can't analyse..pkgartifacts are expanded withpkgutil.--dry-run,--no-input, exit codes 0/1/2/3, and the daily alias. All checked againstprivacycommand upgrade --helpand the code.Security lists
brew upgradeas the sixth outbound call, and the Introduction and FAQ follow.Checks
npm run check: docs check (29 linked files) and llms check pass.npm run linkcheck(lychee): 0 errors.npx mint broken-links: no broken links.Not changed, but stale
Three pages say macOS 13: installation, introduction and FAQ. The app's deployment target is 14.0, and build-from-source says "deployment target is macOS 13.0". Installation also points at Help → Show Onboarding…, which the new shared Help menu replaced with Welcome to privacycommand. I left these for a separate pass.
🤖 Generated with Claude Code