Repository navigation
docs: add user-facing CLI reference (docs/cli.md) and link it - #49
Merged
Merged
Conversation
added 2 commits
October 2, 2026 08:28
The agentredactor CLI (the engine binary's second mode) had no user-facing documentation anywhere — the only complete reference was the maintainer-oriented CLI section of windows/AGENTS.md, mixed with internals that do not belong in user docs. - docs/cli.md: full user reference, verified against core/src/cli.cpp (command surface, keys, PII types, exit codes, Linux-only update and uninstall with --yes) plus scripting examples; internals (Hello transport, test hooks) stay in AGENTS.md - README.md: three-line CLI pointer at the end of the Documentation section - linux/README.md / windows/README.md: cross-links to docs/cli.md - windows/AGENTS.md: anti-drift note — update docs/cli.md when cli.cpp changes
…doc gitignore entry The docs/ row still referenced the Linux implementation spec and port plan, which are not tracked (internal planning docs, deleted from the working tree) — docs/cli.md is the only tracked doc today. Also remove the now-dead .gitignore entry for docs/linux-port-plan.md.
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
1 participant
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.
Adds user-facing documentation for the
agentredactorCLI (git repo only; website separately per plan).Why
The CLI (the engine binary's second mode — same
core/src/cli.cppon both platforms) had no user-facing docs anywhere: the only complete reference was the maintainer-oriented CLI section ofwindows/AGENTS.md, mixed with internals (Hello transport mechanics,AGENTREDACTOR_HELLO_SUPPRESS_PROMPTsecurity invariants, test hooks) that don't belong in user docs.What
docs/cli.md(new) — full reference, verified againstcore/src/cli.cppandlinux/engine/main.cpp: command surface (status,languages,get/set,profiles,regex,keywords,pii-types,password,download-model; Linux-onlyupdate/uninstall [--yes]), key reference, PII type list, exit codes, profile selector semantics, plus scripting examples. Deliberately example-oriented sinceagentredactor helpis the always-in-sync source.README.md— three-line CLI pointer at the end of the Documentation section (no new heading, no tables).linux/README.md/windows/README.md— cross-links.windows/AGENTS.md— anti-drift note: user reference lives indocs/cli.md, update it whencli.cppchanges.Notes
buildchecks still report from the gated jobs).docs/linux-implementation-spec.mdexists untracked in the working tree (357 lines, predates this branch) — left uncommitted; decide separately whether it belongs in the repo.