Add input/output descriptions to --help for 95 CLI scripts#18
Open
olsonanl wants to merge 1 commit into
Open
Conversation
Each script's --help now shows Input, Output, and Example lines before the options list, clarifying whether the script reads from stdin, command-line arguments, or both. Covers all three input patterns: - CLI-only queries (p3-all-*, p3-find-serology-data, etc.) - Stdin pipeline (p3-get-*, p3-find-features, data utilities) - Dual-mode (p3-gto, p3-dump-genomes: args or - for stdin) Uses P3Utils::input_spec() added in p3_core. Co-Authored-By: Claude Opus 4.6 <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.
Summary
--helpoutput for 95p3-scriptsp3-all-*,p3-find-serology-data, etc. — "Input: none (queries BV-BRC database directly)"p3-get-*,p3-find-features, data utilities — "Input: tab-delimited genome IDs on stdin (or --input file)"p3-gto,p3-dump-genomes— "Input: genome IDs as arguments, or - to read from stdin"Depends on
P3Utils::input_spec()from p3_core PR: BV-BRC/p3_core#20Motivation
Users frequently struggle with understanding which scripts read from stdin vs command-line arguments, and how to compose them into pipelines. This adds the answer directly to
--helpwhere they look first.Example
Scripts not modified (3)
p3-aggregates-to-html,p3-project-subsystems,p3-make-genome-list-blast-database— these don't useP3Utils::script_opts()and need individual handling.Test plan
--helpoutput for scripts from each category🤖 Generated with Claude Code