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

CLI help text improvements #95

Open
ryanrichholt opened this issue Nov 19, 2019 · 3 comments
Open

CLI help text improvements #95

ryanrichholt opened this issue Nov 19, 2019 · 3 comments
Labels
enhancement New feature or request good first issue Good for newcomers
Projects

Comments

@ryanrichholt
Copy link
Collaborator

I think there is a lot of room for improvement in the help text for the CLI options.

@ryanrichholt ryanrichholt added enhancement New feature or request good first issue Good for newcomers labels Nov 19, 2019
@ryanrichholt
Copy link
Collaborator Author

ryanrichholt commented Nov 19, 2019

Ideas, some of these are more than just help text:

  • main help subcommand descriptions
  • short option exists for -p/--project, but no short option for --pipeline, what about -P, or is this too confusing?
  • jetstream project --init? == jetstream init
  • jetstream pipeline --init create boiler plate for a new pipeline? or jetstream init --pipeline?
  • jetstream project should take a positional argument for project path. Right now it has to be the cwd or passed with --project which is Clunky.
  • jetstream project should also show project config data with option to only show info/workflow, etc.
  • shorter command alias js? this could be added while leaving the original intact

@PedalheadPHX
Copy link
Member

With my broken hand typing jetstream is a literal pain so an optional short cut is not a bad idea. Would "js" conflict with any linux or python native things?

@ryanrichholt
Copy link
Collaborator Author

With my broken hand typing jetstream is a literal pain so an optional short cut is not a bad idea. Would "js" conflict with any linux or python native things?

That's the tricky part, I need something short, but not in conflict with other tools. jetstream would still be the package name (which is already taken on pypi, if we ever wanted to upload there we would need to change) so no issue with python. But, js... is so polluted by javascript names that I worry about conflicts there.

@ryanrichholt ryanrichholt added this to To do in Version 1.7 Feb 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
Version 1.7
  
To do
Development

No branches or pull requests

2 participants