Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
Improves dbt --help documentation #1060
New and improved CLI help docs:
Note: I'm not attached to any of this copy / verbiage. Please pile on if you have improvements.
This is great @mikekaminsky! Looks like there are some conflicts to resolve, but this will be a really great addition.
What do you think about linking to docs.getdbt.com? We could link to specific sections for subcommands (eg. dbt run), or just plaster a big link in the main help header.
There's a great article on CLI design that @jthandy just turned me on to here: https://medium.com/@jdxcode/12-factor-cli-apps-dd3c227a0e46
I was thinking of implementing the
Thanks for submitting this - it's really great!
Thanks @drewbanin! I just fixed the conflicts and added the link to the docs in the description. I think adding links for very command would be over-kill (plus, not actually that useful in a CLI).
I think the