terraspace 0.6.23 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9ff791ca3b7b100a8f60caa7a8f8a81e97d45e10317b39643b924cfad6696f6
-  data.tar.gz: bd57524893eb19164b38bb8e4495a1577e5784094dd03329565c99200551fe56
+  metadata.gz: 2bd234dcdf6144ab75b3dd1a0c462500a1dd3acd630a2cf9bf7b45b9454c8d8b
+  data.tar.gz: ed32cdf8d20fa2d36b820703d795cc592cf475ae61803a28534786eab12c1fa7
 SHA512:
-  metadata.gz: 80ea2622c03f16a05450b2616a32988c128146cb91319e48bacba6a6ee04c2c6eeae9d006d2f446a5ab91bc1f44fc40e4cdef7ad25ca1b2ff8b42fc8c1703b72
-  data.tar.gz: 6c6ac8a06236ce3dfd827028f1681da5e9f7197c564c85cbf9d9188dd8940e9cdfe810663d33c505b01d05d68fa74fc6be475fb6ea329a21971a384bc094c261
+  metadata.gz: 03a5562ca555795061fad7f2aea07645994099417a7f367df3c37a1dd7749b38530a2a3caa6ca05eac12c853db587a84df0370473728268a96f24ffb713ac20b
+  data.tar.gz: 6b16be5fbc3b1a3f3a1a792314996a942dcf87ce458abb0ac2a13a7bb8dacc73827c3e04387102b65719dfc57c80df97e8353f73b9705ab825d43e1ebd4548ab

data/.cody/README.md

@@ -19,6 +19,8 @@ To start a CodeBuild build:
     cody start --type aws
     cody start --type azurerm
     cody start --type google
+    cody start --type none
+    cody start --type unit
 
 To specify a branch:
 

data/.cody/azurerm/bin/az/configure.sh

@@ -3,7 +3,10 @@
 set -eux
 
 mkdir -p ~/.azure
-aws secretsmanager get-secret-value --secret-id terraspace/azure-client | jq -r '.SecretString | fromjson' > ~/.azure/app-client.json
+
+set +x
+# aws secretsmanager get-secret-value --secret-id terraspace/azure-client | jq -r '.SecretString | fromjson' > ~/.azure/app-client.json
+echo $AZURE_APP_CLIENT_JSON > ~/.azure/app-client.json
 
 # ~/.azure/app-client.json
 export ARM_CLIENT_ID=$(cat ~/.azure/app-client.json | jq -r '.client_id')
@@ -16,6 +19,7 @@ az login --service-principal \
   --username $ARM_CLIENT_ID \
   --password $ARM_CLIENT_SECRET \
   --tenant $ARM_TENANT_ID
+set -x
 
 git clone https://github.com/boltops-tools/azure_check.git
 cd azure_check

data/.cody/azurerm/project.rb

@@ -1,2 +1,6 @@
 github_url("https://github.com/boltops-tools/terraspace.git")
 linux_image("aws/codebuild/amazonlinux2-x86_64-standard:3.0")
+environment_variables(
+  # Used by .cody/azurerm/bin/az/configure.sh
+  AZURE_APP_CLIENT_JSON: ssm("/terraspace/#{Cody.env}/azure_app_client_json"),
+)

data/.cody/azurerm/role.rb

@@ -1,5 +1,4 @@
 iam_policy(
   "logs",
-  "secretsmanager",
   "ssm",
 )

data/.cody/google/bin/gcloud/configure.sh

@@ -3,7 +3,8 @@
 set -eu
 
 mkdir -p ~/.gcp
-aws secretsmanager get-secret-value --secret-id terraspace/gcloud-credentials | jq '.SecretString | fromjson' > ~/.gcp/credentials.json
+# aws secretsmanager get-secret-value --secret-id terraspace/gcloud-credentials | jq '.SecretString | fromjson' > ~/.gcp/credentials.json
+echo $GOOGLE_CREDS_JSON > ~/.gcp/credentials.json
 
 # ~/.gcp/credentials.json
 export GOOGLE_APPLICATION_CREDENTIALS=~/.gcp/credentials.json

data/.cody/google/project.rb

@@ -1,2 +1,6 @@
 github_url("https://github.com/boltops-tools/terraspace.git")
 linux_image("aws/codebuild/amazonlinux2-x86_64-standard:3.0")
+environment_variables(
+  # Used by .cody/google/bin/gcloud/configure.sh
+  GOOGLE_CREDS_JSON: ssm("/terraspace/#{Cody.env}/google_creds_json"),
+)

data/.cody/google/role.rb

@@ -1,5 +1,4 @@
 iam_policy(
   "logs",
-  "secretsmanager",
   "ssm",
 )

data/.cody/none/bin/build.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+set -eu
+
+# will build from /tmp because terraspace/Gemfile may interfere
+cd /tmp
+
+export PATH=~/bin:$PATH # ~/bin/terraspace wrapper
+
+set -x
+terraspace new project infra --plugin none --examples
+cd infra
+terraspace new test demo --type stack
+cd app/stacks/demo
+terraspace test

data/.cody/none/buildspec.yml

@@ -0,0 +1,10 @@
+version: 0.2
+
+phases:
+  install:
+    runtime-versions:
+      ruby: latest
+  build:
+    commands:
+      - .cody/shared/script/install.sh
+      - .cody/none/bin/build.sh

data/.cody/none/project.rb

@@ -0,0 +1,2 @@
+github_url("https://github.com/boltops-tools/terraspace.git")
+linux_image("aws/codebuild/amazonlinux2-x86_64-standard:3.0")

data/.cody/none/role.rb

@@ -0,0 +1,4 @@
+iam_policy(
+  "logs",
+  "ssm",
+)

data/.cody/shared/script/install/terraform.sh

@@ -2,10 +2,18 @@
 
 set -eu
 
-TERRAFORM_VERSION=0.12.26
+TERRAFORM_VERSION=latest
 
-mkdir /tmp/terraform
-cd /tmp/terraform
-wget -q https://releases.hashicorp.com/terraform/${TERRAFORM_VERSION}/terraform_${TERRAFORM_VERSION}_linux_amd64.zip
-unzip terraform_${TERRAFORM_VERSION}_linux_amd64.zip
-mv terraform /usr/local/bin
+git clone https://github.com/tfutils/tfenv.git ~/.tfenv
+echo 'export PATH="$HOME/.tfenv/bin:$PATH"' >> ~/.bash_profile
+export PATH="$HOME/.tfenv/bin:$PATH"
+tfenv install $TERRAFORM_VERSION
+tfenv use $TERRAFORM_VERSION
+
+# Generate wrapper so dont have to worry about adding .tfenv/bin to PATH in codebuild env
+cat << 'EOL' > /usr/local/bin/terraform
+#!/bin/bash
+export PATH="$HOME/.tfenv/bin:$PATH"
+exec terraform "$@"
+EOL
+chmod +x /usr/local/bin/terraform

data/.cody/unit/buildspec.yml

@@ -6,4 +6,5 @@ phases:
       ruby: latest
   build:
     commands:
+      - .cody/shared/script/install/terraform.sh
       - .cody/unit/bin/build.sh

data/.pipedream/pipeline.rb

@@ -12,6 +12,7 @@ stage "Build" do
     "terraspace-aws",
     "terraspace-azurerm",
     "terraspace-google",
+    "terraspace-none",
     "terraspace-unit",
   )
 end

data/CHANGELOG.md

@@ -3,6 +3,69 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [1.0.0] - 2022-01-08
+Highlights:
+- Non-cloud provider support
+- Better passthrough terraspace options to terraform. Pretty much all terraform options are now supported.
+- Remove `terraspace_plugin_*` gem dependencies out of core
+- Improve top CLI help: group main commands at top
+
+Details:
+- [#168](https://github.com/boltops-tools/terraspace/pull/168) terraspace new example command
+- [#169](https://github.com/boltops-tools/terraspace/pull/169) fix new plugin generator, use right include Helper
+- [#170](https://github.com/boltops-tools/terraspace/pull/170) remove project --test-structure option in favor of terraspace new test --type project
+- [#171](https://github.com/boltops-tools/terraspace/pull/171) improve cli help: group main commands at top
+- [#172](https://github.com/boltops-tools/terraspace/pull/172) better wrap and pass through terraform args
+- [#173](https://github.com/boltops-tools/terraspace/pull/173) remove `terraspace_plugin_*` gem dependencies out of core
+- [#174](https://github.com/boltops-tools/terraspace/pull/174) support non-cloud providers and backends
+- [#175](https://github.com/boltops-tools/terraspace/pull/175) Pass args cleanup
+- [#176](https://github.com/boltops-tools/terraspace/pull/176) fix new example command
+- [#177](https://github.com/boltops-tools/terraspace/pull/177) Shim message
+- [#178](https://github.com/boltops-tools/terraspace/pull/178) fix no backend.tf src file case
+- [#179](https://github.com/boltops-tools/terraspace/pull/179) terraspace check setup command
+- [#180](https://github.com/boltops-tools/terraspace/pull/180) hide check_setup command
+- [#181](https://github.com/boltops-tools/terraspace/pull/181) generator improvements: core examples for plugin=none. creates simple random_pet
+- [#182](https://github.com/boltops-tools/terraspace/pull/182) move backend auto creation to runner stage
+- [#183](https://github.com/boltops-tools/terraspace/pull/183) fix example generator lang option
+- allow --version command to run outside terraspace project
+- allow terraspace -help to work also
+- friendly shim message for gem dependency resolution errors
+- Pretty much release 0.7.x
+
+## [0.7.2] - 2022-01-05
+- [#187](https://github.com/boltops-tools/terraspace/pull/187) put thor cli options at the end
+
+## [0.7.1] - 2022-01-04
+- [#185](https://github.com/boltops-tools/terraspace/pull/185) pass value through untouch when expand method not defined
+
+## [0.7.0] - 2021-12-30
+Highlights:
+- Non-cloud provider support
+- Better passthrough terraspace options to terraform. Pretty much all terraform options are now supported.
+- Remove `terraspace_plugin_*` gem dependencies out of core
+- Improve top CLI help: group main commands at top
+
+Details:
+- [#168](https://github.com/boltops-tools/terraspace/pull/168) terraspace new example command
+- [#169](https://github.com/boltops-tools/terraspace/pull/169) fix new plugin generator, use right include Helper
+- [#170](https://github.com/boltops-tools/terraspace/pull/170) remove project --test-structure option in favor of terraspace new test --type project
+- [#171](https://github.com/boltops-tools/terraspace/pull/171) improve cli help: group main commands at top
+- [#172](https://github.com/boltops-tools/terraspace/pull/172) better wrap and pass through terraform args
+- [#173](https://github.com/boltops-tools/terraspace/pull/173) remove `terraspace_plugin_*` gem dependencies out of core
+- [#174](https://github.com/boltops-tools/terraspace/pull/174) support non-cloud providers and backends
+- [#175](https://github.com/boltops-tools/terraspace/pull/175) Pass args cleanup
+- [#176](https://github.com/boltops-tools/terraspace/pull/176) fix new example command
+- [#177](https://github.com/boltops-tools/terraspace/pull/177) Shim message
+- [#178](https://github.com/boltops-tools/terraspace/pull/178) fix no backend.tf src file case
+- [#179](https://github.com/boltops-tools/terraspace/pull/179) terraspace check setup command
+- [#180](https://github.com/boltops-tools/terraspace/pull/180) hide check_setup command
+- [#181](https://github.com/boltops-tools/terraspace/pull/181) generator improvements: core examples for plugin=none. creates simple random_pet
+- [#182](https://github.com/boltops-tools/terraspace/pull/182) move backend auto creation to runner stage
+- [#183](https://github.com/boltops-tools/terraspace/pull/183) fix example generator lang option
+- allow --version command to run outside terraspace project
+- allow terraspace -help to work also
+- friendly shim message for gem dependency resolution errors
+
 ## [0.6.23] - 2021-12-18
 - [#167](https://github.com/boltops-tools/terraspace/pull/167) require active_support properly
 

data/Gemfile

@@ -2,3 +2,9 @@ source "https://rubygems.org"
 
 # Specify your gem dependencies in terraspace.gemspec
 gemspec
+
+group :test do
+  gem "terraspace_plugin_aws"
+  gem "terraspace_plugin_azurerm"
+  gem "terraspace_plugin_google"
+end

data/README.md

@@ -8,18 +8,22 @@
 
 [![BoltOps Badge](https://img.boltops.com/boltops/badges/boltops-badge.png)](https://www.boltops.com)
 
-The Terraform Framework.
+[![BoltOps Learn Badge](https://img.boltops.com/boltops-learn/boltops-learn.png)](https://learn.boltops.com)
+
 
-Please **watch/star** this repo to help grow and support the project.
+The Terraform Framework.
 
 Official Docs Site: [terraspace.cloud](https://terraspace.cloud)
 
-Quick Start Demo:
+## Support the Project
 
-[![Watch the video](https://img.boltops.com/boltops/tools/terraspace/youtube/terraspace-quick-start.png)](https://www.youtube.com/watch?v=EZfsBJx8pxQ)
+* Please **watch/star** this repo to help grow and support the project.
+* Consider subscribing to [BoltOps Learn](https://learn.boltops.com/). You'll get access to many training videos. Subscribing helps support the project.
 
 ## Quick Start
 
+[![Watch the video](https://img.boltops.com/boltops/tools/terraspace/youtube/terraspace-quick-start.png)](https://learn.boltops.com/courses/terraspace-fundamentals/lessons/terraspace-quick-start)
+
 Here are commands to get started:
 
     terraspace new project infra --plugin aws --examples

data/lib/templates/examples/hcl/module/main.tf

@@ -0,0 +1,3 @@
+resource "random_pet" "this" {
+  length = var.length
+}

data/lib/templates/examples/hcl/module/outputs.tf

@@ -0,0 +1,4 @@
+output "id" {
+  description = "Random pet id"
+  value       = random_pet.this.id
+}

data/lib/templates/examples/hcl/module/variables.tf

@@ -0,0 +1,5 @@
+variable "length" {
+  type        = number
+  description = "number of words"
+  default     = 2
+}

data/lib/templates/examples/hcl/stack/main.tf

@@ -0,0 +1,4 @@
+module "pet" {
+  source     = "../../modules/example"
+  length     = var.length
+}

data/lib/templates/examples/hcl/stack/outputs.tf

@@ -0,0 +1,4 @@
+output "pet_id" {
+  description = "Pet id"
+  value       = module.pet.id
+}

data/lib/templates/examples/hcl/stack/variables.tf

@@ -0,0 +1,5 @@
+variable "length" {
+  type        = number
+  description = "number of words"
+  default     = 2
+}

data/lib/templates/examples/ruby/module/main.rb

@@ -0,0 +1,3 @@
+resource("random_pet", "this",
+  length: var.length
+)

data/lib/templates/examples/ruby/module/outputs.rb

@@ -0,0 +1,4 @@
+output("id",
+  description: "Random pet id",
+  value:       "${random_pet.this.id}",
+)

data/lib/templates/examples/ruby/module/variables.rb

@@ -0,0 +1,5 @@
+variable("length",
+  type:        :number,
+  description: "number of words",
+  default:     2,
+)

data/lib/templates/examples/ruby/stack/main.rb

@@ -0,0 +1,4 @@
+module!("pet",
+  source: "../../modules/example",
+  length: var.length,
+)

data/lib/templates/examples/ruby/stack/outputs.rb

@@ -0,0 +1,4 @@
+output("pet_id",
+  description: "Pet id",
+  value:       "${module.pet.id}",
+)

data/lib/templates/examples/ruby/stack/variables.rb

@@ -0,0 +1,5 @@
+variable("length",
+  type:        :number,
+  description: "number of words",
+  default:     2,
+)

data/lib/templates/hcl/project/config/terraform/backend.tf.tt

@@ -1,18 +1,10 @@
-# This is where you put your backend declaration. Here are some examples:
+# This is where you put your backend declaration. Example:
 #
 # terraform {
-#   backend "s3" {
-#     bucket         = "<%= options[:bucket] || "terraform-state-:ACCOUNT-:REGION-:ENV" %>"
-#     key            = "<%%= expansion(":REGION/:ENV/:BUILD_DIR/terraform.tfstate") %> # IE: us-west-2/dev/ec2/modules/vpc/terraform.tfstate
-#     region         = "<%%= expansion(":REGION") %>"
-#     encrypt        = true
-#     dynamodb_table = "terraform_locks"
+#   backend "local" {
+#     path = "terraform.tfstate"
 #   }
 # }
 #
-# terraform {
-#   backend "gcs" {
-#     bucket = "<%= options[:bucket] || "terraform-state-:PROJECT-:REGION-:ENV" %>"
-#     prefix = "<%%= expansion(":REGION/:ENV/:BUILD_DIR") %>" # IE: us-central1/dev/modules/vm
-#   }
-# }
+# More examples: https://terraspace.cloud/docs/config/backend/examples/
+#

data/lib/templates/hcl/project/config/terraform/provider.tf

@@ -1,16 +1,6 @@
-# This is where you put your provider declaration. Here are some examples:
+# This is where you put your provider declaration.
 #
-# provider "aws" {
-#   region = "<%= ENV['AWS_REGION'] || 'us-east-1' %>"
-# }
+# If you end up adding a cloud provider, you should also configure a terraspace_plugin_* gem
+# in the Terraspace project Gemfile and run bundle.
 #
-# Docs: https://www.terraform.io/docs/providers/aws/index.html
-#
-# provider "google" {
-#   project = "REPLACE_ME"
-#   region  = "us-central1"   # update to your region
-#   zone    = "us-central1-a" # update to your zone
-# }
-#
-# Docs: https://www.terraform.io/docs/providers/google/index.html
-#
+# See: https://terraspace.cloud/docs/plugins/

data/lib/terraspace/autodetect.rb

@@ -0,0 +1,15 @@
+module Terraspace
+  class Autodetect
+    def plugin
+      plugins = Terraspace::Plugin.meta.keys
+      if plugins.size == 1
+        plugins.first
+      else
+        precedence = %w[aws azurerm google]
+        precedence.find do |p|
+          plugins.include?(p)
+        end
+      end
+    end
+  end
+end

data/lib/terraspace/autoloader.rb

@@ -1,6 +1,10 @@
 require "terraspace/bundle"
 Terraspace::Bundle.setup
-require "zeitwerk"
+begin
+  require "zeitwerk"
+rescue LoadError => e
+  Terraspace::Bundle.handle_already_activated_error(e)
+end
 
 module Terraspace
   # These modules are namespaces for user-defined custom helpers
@@ -38,3 +42,4 @@ module Terraspace
     end
   end
 end
+

data/lib/terraspace/builder.rb

@@ -8,7 +8,7 @@ module Terraspace
 
     def run
       return if @options[:build] == false
-      Terraspace::CLI::CheckSetup.check!
+      Terraspace::CLI::Setup::Check.check!
       @mod.root_module = true
       clean
       build_dir = Util.pretty_path(@mod.cache_dir)
@@ -20,7 +20,6 @@ module Terraspace
       run_hooks("terraspace.rb", "build") do
         check_allow!
         build_unresolved
-        auto_create_backend
         batches = build_batches
         build_all
         logger.info "Built in #{build_dir}" unless @options[:quiet] # from terraspace all
@@ -66,13 +65,6 @@ module Terraspace
       end
     end
 
-    # Auto create after build_unresolved since will need to run state pull for dependencies
-    def auto_create_backend
-      return if Terraspace.config.auto_create_backend == false
-      return unless requires_backend?
-      Terraspace::Compiler::Backend.new(@mod).create
-    end
-
     def clean
       Compiler::Cleaner.new(@mod, @options).clean if clean?
     end

data/lib/terraspace/bundle.rb

@@ -55,6 +55,60 @@ module Terraspace
       [:default, Terraspace.env.to_sym]
     end
 
+    # When there are gem dependency issues, requiring zeitwerk with this debugging code
+    #     begin
+    #       require "zeitwerk"
+    #     rescue LoadError => e
+    #       puts "#{e.class}: #{e.message}"
+    #       exit 1
+    #     end
+    #
+    # Produces:
+    #
+    #     You have already activated faraday 1.8.0, but your Gemfile requires faraday 1.7.2. Prepending `bundle exec` to your command may solve this.
+    #     LoadError: cannot load such file -- zeitwerk
+    #
+    # Sadly, the captured exception only contains this info:
+    #
+    #     LoadError: cannot load such file -- zeitwerk
+    #
+    # The useful "already activated" info that shows gem dependencies issues. Example:
+    #
+    #     You have already activated faraday 1.8.0, but your Gemfile requires faraday 1.7.2. Prepending `bundle exec` to your command may solve this.
+    #
+    # Is printed to stdout earlier and before exception.
+    #
+    # So making an assumption that a zeitwerk LoadError is due to gem dependencies issue.
+    # It's not ideal, but think this is ok.
+    #
+    # Note: Not checking shim upon install because it wont be a good user experience
+    # to check for a shim unless this error actually occurs.
+    #
+    # Only been able to reproduce this error for a gem install with: alpine
+    # The standalone install already has a shim wrapper.
+    #
+    def handle_already_activated_error(e)
+      # color is not yet available
+      puts "ERROR: #{e.class}: #{e.message}" if ENV['TS_DEBUG_ALREADY_ACTIVATED']
+      check_shim!
+      exit 1
+    end
+
+    def check_shim!
+      return unless File.exist?("Gemfile")
+      $stderr.puts <<~EOL
+        Looks like there are issues trying to resolve gem dependencies.
+
+        To resolve this, you can generate a shim:
+
+            terraspace new shim
+
+        You only have to do this one time.
+
+        More info: https://terraspace.cloud/docs/install/shim/
+      EOL
+    end
+
     extend self
   end
 end

data/lib/terraspace/cli/concern.rb

@@ -0,0 +1,113 @@
+class Terraspace::CLI
+  module Concern
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # So the Thor::Parser::Options#parse allows flag switch shorthand notation. IE:
+      #
+      #    command -abc
+      #
+      # Is same as:
+      #
+      #    command -a -b -c
+      #
+      # This messes up the options like -destroy.
+      #
+      #    terraspace plan -destroy
+      #
+      # Since only a single dash (-) is passed. It's interpreted as a bunch of flag switches.
+      # Providing -- works just fine
+      #
+      #    terraspace plan --destroy
+      #
+      # But it'll be nice if user can use -destroy or --destroy
+      #
+      # Interestingly, -no-color won't be interpreted by Thor as switch flag due to the - inbetween.
+      #
+      # Looked into the Thor code:
+      #
+      #   Thor::Parser::Options#parse https://github.com/rails/thor/blob/5c666b4c25e748e57eec2d529d94c5059030979e/lib/thor/parser/options.rb#L88
+      #   Thor::Parser::Options#current_is_switch? https://github.com/rails/thor/blob/5c666b4c25e748e57eec2d529d94c5059030979e/lib/thor/parser/options.rb#L165
+      #
+      # Overriding the current_is_switch? is dirtier than overriding start
+      # and adjusting the argv before passing to Thor.
+      #
+      # There are only so few Terraform boolean options that are single words. To find (fish shell)
+      #
+      #     for i in init validate plan apply destroy console fmt force-unlock get graph import login logout output providers refresh show state taint test untaint version workspace ; echo "$i:" ; terraform $i -h | grep '^  -' ; end
+      #     for i in init validate plan apply destroy console fmt force-unlock get graph import login logout output providers refresh show state taint test untaint version workspace ; echo "$i:" ; terraform $i -h | grep '^  -' | grep -v =  | sed 's/  -//' | grep -v - | sed -r 's/\s+.*//' | sed 's/^/  /' ; end
+      #     for i in init validate plan apply destroy console fmt force-unlock get graph import login logout output providers refresh show state taint test untaint version workspace ; terraform $i -h | grep '^  -' | grep -v =  | sed 's/  -//' | grep -v - | sed -r 's/\s+.*//' ; end | sort | uniq
+      #
+      def start(argv)
+        # Note: help is for terraspace -help
+        single_word_boolean_args = %w[
+          check
+          destroy
+          diff
+          force
+          help
+          json
+          raw
+          reconfigure
+          recursive
+          upgrade
+        ]
+        args = single_word_boolean_args.map { |s| "-#{s}" }
+        argv.map! do |arg|
+          if args.include?(arg)
+            # Ensure double dash (--).
+            # Later in Terraspace::Terraform::Args::Pass#args a single dash (-) is ensured.
+            "-#{arg}" # IE: -destroy => --destroy
+          else
+            arg
+          end
+        end
+        super(argv)
+      end
+
+      def main_commands
+        %w[
+          all
+          build
+          bundle
+          down
+          list
+          new
+          plan
+          seed
+          up
+        ]
+      end
+
+      def help(shell, subcommand)
+        list = printable_commands(true, subcommand)
+        list.sort! { |a, b| a[0] <=> b[0] }
+        filter = Proc.new do |command, desc|
+          main_commands.detect { |name| command =~ Regexp.new("^terraspace #{name}") }
+        end
+        main = list.select(&filter)
+        other = list.reject(&filter)
+
+        shell.say <<~EOL
+          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.
+        EOL
+        shell.say "\nMain Commands:\n\n"
+        shell.print_table(main, indent: 2, truncate: true)
+        shell.say "\nOther Commands:\n\n"
+        shell.print_table(other, indent: 2, truncate: true)
+        shell.say <<~EOL
+
+          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/
+        EOL
+      end
+    end
+  end
+end

data/lib/terraspace/cli/help/new/example.md

@@ -1,8 +1,14 @@
 ## Example
 
-    => Creating test for new module: example
+    $ terraspace new example
+    => Creating new module called example
           create  app/modules/example
           create  app/modules/example/main.tf
           create  app/modules/example/outputs.tf
           create  app/modules/example/variables.tf
+    => Creating new stack called demo
+          create  app/stacks/demo
+          create  app/stacks/demo/main.tf
+          create  app/stacks/demo/outputs.tf
+          create  app/stacks/demo/variables.tf
     $