Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TKML tool not showing global args in help menu #218

Open
danielholanda opened this issue Aug 19, 2024 · 1 comment
Open

TKML tool not showing global args in help menu #218

danielholanda opened this issue Aug 19, 2024 · 1 comment
Labels
bug Something isn't working p1 Medium priority

Comments

@danielholanda
Copy link
Collaborator

Description

Management tools are not showing global args in help menu, resulting in a poor user experience.

Example

turnkey cache --help
usage: turnkey cache [-h] (-b BUILD_NAMES [BUILD_NAMES ...] | -a) (-l | -s | --delete | --clean)

options:
  -h, --help            show this help message and exit
  -b BUILD_NAMES [BUILD_NAMES ...], --build-names BUILD_NAMES [BUILD_NAMES ...]
                        Name of the specific build(s) to be operated upon, within the cache directory
  -a, --all             Operate on all the builds in the cache
  -l, --list            List all of the builds in the cache
  -s, --stats           Print the collected stats for the selected build(s)
  --delete              Permanently delete the selected build(s)
  --clean               Remove the build artifacts from the selected build(s)

Should be something along the lines of

turnkey cache --help
usage: turnkey [--cache-dir CACHE_DIR] cache [-h] (-b BUILD_NAMES [BUILD_NAMES ...] | -a) (-l | -s | --delete | --clean)

positional arguments (to be used before the tool 'cache '):
  cache_dir          Path to the cache directory
  
options:
  -h, --help            show this help message and exit
  -b BUILD_NAMES [BUILD_NAMES ...], --build-names BUILD_NAMES [BUILD_NAMES ...]
                        Name of the specific build(s) to be operated upon, within the cache directory
  -a, --all             Operate on all the builds in the cache
  -l, --list            List all of the builds in the cache
  -s, --stats           Print the collected stats for the selected build(s)
  --delete              Permanently delete the selected build(s)
  --clean               Remove the build artifacts from the selected build(s)
@danielholanda danielholanda added bug Something isn't working p1 Medium priority labels Aug 19, 2024
@jeremyfowers
Copy link
Collaborator

Unassigning myself because I dont promise to get this done before pat leave. It's a stretch goal for me.

@jeremyfowers jeremyfowers removed their assignment Aug 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working p1 Medium priority
Projects
None yet
Development

No branches or pull requests

2 participants