PROD-2195 / PROD-2196: Fix hidden CLI flags in --help and correct README#162
Closed
5PK wants to merge 1 commit into
Closed
PROD-2195 / PROD-2196: Fix hidden CLI flags in --help and correct README#1625PK wants to merge 1 commit into
5PK wants to merge 1 commit into
Conversation
- Remove self-referencing yargs aliases (sourceGuid, targetGuid, overwrite, force, autoPublish) which caused yargs to hide those options from --help - Decouple --reset from --update: "reset" was declared as an alias of update, colliding with the separate reset option, hiding it from help and overwriting update's description - Remove dead targetGuid override in push builder (it was silently reverted by the ...systemArgs spread; requirement is enforced in validateCommand after .env priming so AGILITY_TARGET_GUID keeps working) - README: document conflict-scoped --overwrite behavior, correct --models-with-deps to include pages, mark pull --sourceGuid optional with AGILITY_GUID fallback, add Sitemaps to --elements default, and document missing flags (--channel, --preview, --dryRun, --contentIDs, --pageIDs, --insecure, --legacyFolders, --baseUrl, --token, --force, --reset, dev modes) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Collaborator
Author
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.
Summary
Fixes PROD-2195 (CLI
--helpomits real flags) and PROD-2196 (README inaccurate/outdated for several pull & sync flags).PROD-2195 — hidden flags in
--helpRoot cause: yargs silently hides any option whose
aliasarray contains the option's own key.sourceGuid,targetGuid,overwrite,force, andautoPublishall listed their own name as an alias, so they never rendered inpull/push/synchelp.Additionally,
updatedeclared"reset"as an alias, colliding with the separateresetoption — this hid--resetfrom help and overwrote--update's description with reset's text.--resetfrom--update; moved theReset/RESETcase variants onto theresetoption. Note: previously--resetalso implied--update=truevia the alias collision; they are now independent flags (pull and sync forceupdate=truein their handlers anyway)targetGuidoverride in the push builder — it was defined before the...systemArgsspread, which silently reverted itsdemandOption: true. The requirement is enforced inauth.validateCommand()after.envpriming, so the documentedAGILITY_TARGET_GUIDfallback keeps workingtargetGuidhelp text now mentions theAGILITY_TARGET_GUIDfallbackAll systemArgs options (
--sourceGuid,--targetGuid,--overwrite,--force,--reset,--autoPublish, etc.) now appear inpull/push/sync --help— verified against a local build.PROD-2196 — README corrections (all 5 reported items)
--overwritenow documented as conflict-scoped (only overwrites target items in conflict with the source), matching the implementation in the model/content pushers--models-with-depsnow documented as including pages (plus templates), matching the CLI behavior and help textpull --sourceGuidmarked optional withAGILITY_GUID.envfallback--channel,--preview,--dryRun,--contentIDs,--pageIDs,--insecure,--legacyFolders,--baseUrl,--token,--force,--reset, plus a note on developer modes (--dev,--local,--preprod,--test)--elementsdefault list now includesSitemaps🤖 Generated with Claude Code