docs(help): separate --demo from config-driven one-shot (#1121)#1122
Open
FabioLeitao wants to merge 1 commit into
Open
docs(help): separate --demo from config-driven one-shot (#1121)#1122FabioLeitao wants to merge 1 commit into
FabioLeitao wants to merge 1 commit into
Conversation
Clarify that --demo uses a synthetic workspace under /tmp/data_boar_demo/ and ignores config.yaml in the CWD on /help, USAGE*, and man page.
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.
Summary
/help(How to run a scan → For automation / scripting):--demois now its own block withhelp.run_cli_demo(EN + pt-BR); one-shot examples are labeled config-driven.docs/USAGE.md/docs/USAGE.pt_BR.md: new--demoargument row + dedicated section before one-shot audit.docs/data_boar.1: clearer--demoOPTIONS text (/tmp/data_boar_demo/, ignores CWDconfig.yaml); EXAMPLES split into Zero-config demo vs One-shot CLI (config-driven).Closes #1121.
Test plan
./scripts/check-all.shgreenpytest tests/test_operator_help_sync.pyMade with Cursor