docs: fix README CLI reference — add missing commands and update configure deprecation note#605
Merged
jamesadevine merged 1 commit intoMay 18, 2026
Conversation
…igure description The CLI Reference section was missing 6 commands added since the last docs update: secrets, disable, remove, list, status, and run. The deprecated configure command also had a stale description. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.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
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.
Documentation Freshness Audit
This audit found the following inconsistencies between code and documentation:
Findings
secrets,disable,remove,list,status,runREADME.mdconfiguredescribed as "Detect agentic pipelines and update GITHUB_TOKEN on ADO definitions" — stale; it is now a hidden deprecated alias forsecrets set GITHUB_TOKENREADME.mdDetails
Missing commands in README CLI Reference
The CLI Reference block in
README.mdlisted only 8 commands (init,compile,check,mcp,mcp-http,execute,configure,enable). Six commands that exist insrc/main.rswere absent:secrets—set/list/deletesubcommands for managing pipeline-variable secrets on ADO definitionsdisable— setsqueueStatustodisabledorpausedon matched ADO definitionsremove— deletes matched ADO build definitions (destructive)list— lists matched ADO definitions with their latest-run statestatus— per-pipeline status block for matched ADO definitionsrun— queues builds for matched definitions with optional completion pollingStale
configuredescriptionconfigurewas described as "Detect agentic pipelines and update GITHUB_TOKEN on ADO definitions", which was its original purpose. It is now a deprecated,--help-hidden alias that simply forwards tosecrets set GITHUB_TOKEN(seesrc/configure.rs). The fix removes it from the command table and adds a deprecation note directing users tosecrets set GITHUB_TOKEN.Applied Fixes
secrets,disable,remove,list,status,runto the CLI Reference command table inREADME.mdconfigurefrom the command table and replaced it with a deprecation noteThis pull request was created by the automated documentation freshness check.