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

improve cli help: group main commands at top #171

Merged
merged 1 commit into from
Dec 26, 2021
Merged

improve cli help: group main commands at top #171

merged 1 commit into from
Dec 26, 2021

Conversation

tongueroo
Copy link
Contributor

@tongueroo tongueroo commented Dec 26, 2021

This is a πŸ™‹β€β™‚οΈ feature or enhancement.

  • I've added tests (if it's a bug, feature or enhancement)
  • I've adjusted the documentation (if it's a feature or enhancement)
  • The test suite passes (run bundle exec rspec to verify this)

Summary

Improve the top-level terraspace -h command. Examples:

terraspace help
terraspace --help
terraspace -h

Example with output:

$ terraspace -h
Usage: terraspace COMMAND [args]

The available commands are listed below.
The primary workflow commands are given first, followed by
less common or more advanced commands.

Main Commands:

  terraspace all SUBCOMMAND  # all subcommands
  terraspace build [STACK]   # Build project.
  terraspace bundle          # Bundle with Terrafile.
  terraspace down STACK      # Destroy infrastructure stack.
  terraspace list            # List stacks and modules.
  terraspace new SUBCOMMAND  # new subcommands
  terraspace plan STACK      # Plan stack.
  terraspace seed STACK      # Build starer seed tfvars file.
  terraspace up STACK        # Deploy infrastructure stack.

Other Commands:

  terraspace check_setup             # Check setup.
  terraspace clean SUBCOMMAND        # clean subcommands
  terraspace completion *PARAMS      # Prints words for auto-completion.
  terraspace completion_script       # Generates a script that can be eval to setup auto-completion.
  terraspace console STACK           # Run console in built terraform project.
  terraspace fmt                     # Run terraform fmt
  terraspace force_unlock            # Calls terrform force-unlock
  terraspace help [COMMAND]          # Describe available commands or one specific command
  terraspace info STACK              # Get info about stack.
  terraspace init STACK              # Run init in built terraform project.
  terraspace logs [ACTION] [STACK]   # View and tail logs.
  terraspace output STACK            # Run output.
  terraspace providers STACK         # Show providers.
  terraspace refresh STACK           # Run refresh.
  terraspace show STACK              # Run show.
  terraspace state SUBCOMMAND STACK  # Run state.
  terraspace summary                 # Summarize resources.
  terraspace test                    # Run test.
  terraspace tfc SUBCOMMAND          # tfc subcommands
  terraspace validate STACK          # Validate stack.
  terraspace version                 # Prints version.

For more help on each command, you can use the -h option. Example:

    terraspace up -h

CLI Reference also available at: https://terraspace.cloud/reference/
$

How to Test

terraspace -h

Version Changes

Patch

@tongueroo tongueroo merged commit f28c99d into master Dec 26, 2021
@tongueroo tongueroo deleted the cli-help branch December 26, 2021 00:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant