Update help text for commands + params in CLI and top-level API

[dbeatty10]

resolves #6546

Description

See #6546 for description.

Removals

• dbt parse --compile/--no-compile
• dbt parse --write-manifest
• dbt compile --parse-only
• dbt show --parse-only

Additions

Added these three as synonyms per suggestion "12-factor CLI" and CLIG:

• --version
• -V
• -v

Same thing here:

• --quiet
• -q

By explicitly attaching -V, -v, and -q to their most conventional uses, we can proactively prevent them from accidentally being attached in a non-conventional way.

Help text reviewed

Reviewed the output of:

• dbt build --help
• dbt clean --help
• dbt compile --help
• dbt debug --help
• dbt deps --help
• dbt docs --help
• dbt init --help
• dbt list --help
• dbt parse --help
• dbt run --help
• dbt run-operation --help
• dbt seed --help
• dbt snapshot --help
• dbt source --help
• dbt test --help

Testing

• ⚠️ dbt debug --config-dir doesn't appear in any functional tests

Side notes

CLIG suggests:

• flags like --json and --plain to specify how output is rendered to standard out
• standard usage of -o, --output is to specify the path of the output file

However, we are using --output json and --output text instead of --json and --plain in multiple sub-commands. The one exception is dbt source freshness --output PATH which does accept an output file path.

I'm not sure how much pain or annoyance any of this is causing though.

Checklist

• I have read the contributing guide and understand what's expected of me
• I have signed the CLA
• I have run this code in development and it appears to resolve the stated issue
• This PR includes tests, or tests are not required/relevant for this PR
• I have opened an issue to add/update docs, or docs changes are not required/relevant for this PR
• I have run changie new to create a changelog entry
• I have reviewed the following TODO's:
  • git grep "TODO" core/dbt/cli/main.py
  • git grep "TODO" core/dbt/cli/params.py

[github-actions]

Thank you for your pull request! We could not find a changelog entry for this change. For details on how to document a change, see the contributing guide.

[jtcohen6]

@dbeatty10 Is this nearly ready for review? Even if you didn't get 100% through all commands/params, I'd love to include what you've already got, before we cut v1.5.0-rc1 next week!

[dbeatty10]

@dbeatty10 Is this nearly ready for review? Even if you didn't get 100% through all commands/params, I'd love to include what you've already got, before we cut v1.5.0-rc1 next week!

I can put this up for review later today 👍

[aranke]

Added these three as synonyms per suggestion "12-factor CLI" and CLIG

Love to see this, thanks @dbeatty10!