docs: Added a Markdown printout of the commands.

skyzyx · skyzyx · commit 4356147c7801 · 2025-08-23T01:32:32.000-06:00
diff --git a/cmd/root.go b/cmd/root.go
@@ -89,3 +89,9 @@ func Execute() {
 		os.Exit(1)
 	}
 }
+
+// Root exposes the root command for tools like doc generators.
+// https://cobra.dev/docs/how-to-guides/clis-for-llms/
+func Root() *cobra.Command {
+	return rootCmd
+}
diff --git a/docs/cli/terraform-provider-corefunc.md b/docs/cli/terraform-provider-corefunc.md
@@ -0,0 +1,51 @@
+---
+title: "terraform-provider-corefunc"
+slug: "terraform-provider-corefunc"
+description: "CLI reference for terraform-provider-corefunc"
+---
+
+## terraform-provider-corefunc
+
+Utilities that should have been Terraform core functions.
+
+### Synopsis
+
+terraform-provider-corefunc
+
+Utilities that should have been Terraform core functions.
+
+While some of these _can_ be implemented in HCL, some of them begin to push up
+against the limits of Terraform and the HCL2 configuration language. We also
+perform testing using the Terratest <https://terratest.gruntwork.io> framework
+on a regular basis. Exposing these functions as both a Go library as well as a
+Terraform provider enables us to use the same functionality in both our
+Terraform applies as well as while using a testing framework.
+
+Since Terraform doesn't have the concept of user-defined functions, the next
+step to open up the possibilities is to write a custom Terraform Provider which
+has the functions built-in, using Terraform's existing support for inputs and
+outputs.
+
+**This does not add new syntax or constructs to Terraform.** Instead it uses the
+existing concepts around Providers, Resources, Data Sources, Variables, and
+Outputs to expose new custom-built functionality.
+
+The goal of this provider is not to call any APIs, but to provide pre-built
+functions in the form of Data Sources.
+
+```bash
+terraform-provider-corefunc [flags]
+```
+
+### Options
+
+```text
+  -d, --debug   Run with support for Go debuggers like delve. https://flwd.dk/3k055Lh
+  -h, --help    help for terraform-provider-corefunc
+```
+
+### See also
+
+* [terraform-provider-corefunc json2toml](terraform-provider-corefunc_json2toml.md) - Converts JSON to TOML.
+* [terraform-provider-corefunc toml2json](terraform-provider-corefunc_toml2json.md) - Converts TOML to JSON.
+* [terraform-provider-corefunc version](terraform-provider-corefunc_version.md) - Long-form version information
diff --git a/docs/cli/terraform-provider-corefunc_json2toml.md b/docs/cli/terraform-provider-corefunc_json2toml.md
@@ -0,0 +1,27 @@
+---
+title: "terraform-provider-corefunc json2toml"
+slug: "terraform-provider-corefunc_json2toml"
+description: "CLI reference for terraform-provider-corefunc json2toml"
+---
+
+## terraform-provider-corefunc json2toml
+
+Converts JSON to TOML.
+
+### Synopsis
+
+Converts JSON to TOML.
+
+```bash
+terraform-provider-corefunc json2toml [flags]
+```
+
+### Options
+
+```text
+  -h, --help   help for json2toml
+```
+
+### See also
+
+* [terraform-provider-corefunc](terraform-provider-corefunc.md) - Utilities that should have been Terraform core functions.
diff --git a/docs/cli/terraform-provider-corefunc_toml2json.md b/docs/cli/terraform-provider-corefunc_toml2json.md
@@ -0,0 +1,27 @@
+---
+title: "terraform-provider-corefunc toml2json"
+slug: "terraform-provider-corefunc_toml2json"
+description: "CLI reference for terraform-provider-corefunc toml2json"
+---
+
+## terraform-provider-corefunc toml2json
+
+Converts TOML to JSON.
+
+### Synopsis
+
+Converts TOML to JSON.
+
+```bash
+terraform-provider-corefunc toml2json [flags]
+```
+
+### Options
+
+```text
+  -h, --help   help for toml2json
+```
+
+### See also
+
+* [terraform-provider-corefunc](terraform-provider-corefunc.md) - Utilities that should have been Terraform core functions.
diff --git a/docs/cli/terraform-provider-corefunc_version.md b/docs/cli/terraform-provider-corefunc_version.md
@@ -0,0 +1,28 @@
+---
+title: "terraform-provider-corefunc version"
+slug: "terraform-provider-corefunc_version"
+description: "CLI reference for terraform-provider-corefunc version"
+---
+
+## terraform-provider-corefunc version
+
+Long-form version information
+
+### Synopsis
+
+Long-form version information, including the build commit hash, build date, Go
+version, and external dependencies.
+
+```bash
+terraform-provider-corefunc version [flags]
+```
+
+### Options
+
+```text
+  -h, --help   help for version
+```
+
+### See also
+
+* [terraform-provider-corefunc](terraform-provider-corefunc.md) - Utilities that should have been Terraform core functions.
diff --git a/go.mod b/go.mod
@@ -45,6 +45,7 @@ require (
 	github.com/charmbracelet/x/exp/color v0.0.0-20250821175832-f235fab04313 // indirect
 	github.com/charmbracelet/x/term v0.2.1 // indirect
 	github.com/cloudflare/circl v1.6.1 // indirect
+	github.com/cpuguy83/go-md2man/v2 v2.0.6 // indirect
 	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
 	github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f // indirect
 	github.com/fatih/color v1.18.0 // indirect
@@ -93,6 +94,7 @@ require (
 	github.com/pjbgf/sha1cd v0.4.0 // indirect
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
 	github.com/rivo/uniseg v0.4.7 // indirect
+	github.com/russross/blackfriday/v2 v2.1.0 // indirect
 	github.com/sergi/go-diff v1.4.0 // indirect
 	github.com/spf13/pflag v1.0.7 // indirect
 	github.com/vmihailenco/msgpack v4.0.4+incompatible // indirect
diff --git a/go.sum b/go.sum
@@ -48,6 +48,7 @@ github.com/charmbracelet/x/term v0.2.1 h1:AQeHeLZ1OqSXhrAWpYUtZyX1T3zVxfpZuEQMIQ
 github.com/charmbracelet/x/term v0.2.1/go.mod h1:oQ4enTYFV7QN4m0i9mzHrViD7TQKvNEEkHUMCmsxdUg=
 github.com/cloudflare/circl v1.6.1 h1:zqIqSPIndyBh1bjLVVDHMPpVKqp8Su/V+6MeDzzQBQ0=
 github.com/cloudflare/circl v1.6.1/go.mod h1:uddAzsPgqdMAYatqJ0lsjX1oECcQLIlRpzZh3pJrofs=
+github.com/cpuguy83/go-md2man/v2 v2.0.6 h1:XJtiaUW6dEEqVuZiMTn1ldk455QWwEIsMIJlo5vtkx0=
 github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/cyphar/filepath-securejoin v0.4.1 h1:JyxxyPEaktOD+GAnqIqTf9A8tHyAG22rowi7HkoSU1s=
@@ -222,6 +223,7 @@ github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUc
 github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs=
 github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ=
 github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc=
+github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/sergi/go-diff v1.4.0 h1:n/SP9D5ad1fORl+llWyN+D6qoUETXNZARKjyY2/KVCw=
 github.com/sergi/go-diff v1.4.0/go.mod h1:A0bzQcvG0E7Rwjx0REVgAGH58e96+X0MeOfepqsbeW4=
diff --git a/internal/tools/docgen/main.go b/internal/tools/docgen/main.go

Original file line number	Diff line number	Diff line change
`@@ -89,3 +89,9 @@ func Execute() {`
`89`	`89`	`os.Exit(1)`
`90`	`90`	`}`
`91`	`91`	`}`
	`92`	`+`
	`93`	`+// Root exposes the root command for tools like doc generators.`
	`94`	`+// https://cobra.dev/docs/how-to-guides/clis-for-llms/`
	`95`	`+func Root() *cobra.Command {`
	`96`	`+ return rootCmd`
	`97`	`+}`