turbot / steampipe

Zero-ETL, infinite possibilities. Live query APIs, code & more with SQL. No DB required.
https://steampipe.io
GNU Affero General Public License v3.0
6.92k stars 274 forks source link

show example of mod install syntax? #1817

Closed judell closed 1 year ago

judell commented 2 years ago

Currently, steampipe mod install --help is as below.

I do this infrequently enough to always need to go to the docs to remind myself that the command I'm looking for is like this:

steampipe mod install github.com/turbot/steampipe-mod-aws-thrifty

Could we include an example like that?

steampipe mod install --help
Install one or more mods and their dependencies.

Usage:
  steampipe mod install [flags]

Flags:
      --dry-run   Show which mods would be installed/updated/uninstalled without modifying them
  -h, --help      Help for install
      --prune     Remove unused dependencies after installation is complete (default true)

Global Flags:
      --cloud-host string           Steampipe Cloud host (default "cloud.steampipe.io")
      --cloud-token string          Steampipe Cloud authentication token
      --install-dir string          Path to the Config Directory (defaults to ~/.steampipe) (default "~/.steampipe")
      --schema-comments             Include schema comments when importing connection schemas (default true)
      --workspace string            Path to the workspace working directory (DEPRECATED: please use workspace-chdir)
      --workspace-chdir string      Path to the workspace working directory
pskrbasu commented 1 year ago

Completed in https://github.com/turbot/steampipe/pull/3821