Skip to content

Commit a7defd1

Browse files
committed
feat: Update root command description
1 parent b471f7b commit a7defd1

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

cmd/root.go

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,22 @@ import (
1414

1515
var (
1616
// rootCmd represents the base command when called without any subcommands.
17-
rootCmd = &cobra.Command{
17+
okString = "`ok`"
18+
rootCmd = &cobra.Command{
1819
Use: "ok",
1920
Short: "The `ok` infrastructure toolbox.",
20-
Long: "The " + "`ok` " + `tool helps you to create a fresh Terraform environment (like prod or development) and configure it to use remote state storage.
21+
Long: fmt.Sprintf(`The %s tool is a comprehensive infrastructure management toolbox designed to streamline the setup and maintenance of Terraform environments. It provides a variety of commands to bootstrap infrastructure, manage environment configurations, handle AWS operations, and more.
2122
22-
Your environment is configured using a ` + "`packages.yml`" + ` file. This file is a package manifest listing the components from Golden Path that you wish to use. An example can be found in the ` + "`pirates-iac` " + `repository.`,
23+
Key functionalities include:
24+
25+
- Creating and configuring new Terraform environments.
26+
- Bootstrapping S3 buckets and DynamoDB tables for remote state storage.
27+
- Managing environment variables and configuration files.
28+
- Executing AWS-specific commands.
29+
- Scaffolding new Terraform projects with predefined Boilerplate templates.
30+
- Managing and updating Boilerplate templates.
31+
32+
Whether you're setting up a new environment or maintaining an existing one, %s simplifies and automates many of the repetitive tasks involved in infrastructure management.`, okString, okString),
2333
SilenceErrors: true,
2434
SilenceUsage: true,
2535
}

0 commit comments

Comments
 (0)