https://github.com/shmokmt/tf-docs-finder

This utility tool is designed to immediately open the documentation of a Terraform Provider from the command line.
https://github.com/shmokmt/tf-docs-finder

documentation-tool infrastructure-as-code terraform terraform-provider

Last synced: 9 days ago
JSON representation

This utility tool is designed to immediately open the documentation of a Terraform Provider from the command line.

• Host: GitHub
• URL: https://github.com/shmokmt/tf-docs-finder
• Owner: shmokmt
• License: mpl-2.0
• Created: 2023-05-30T10:23:42.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-11T03:45:08.000Z (5 months ago)
• Last Synced: 2024-06-11T04:48:46.301Z (5 months ago)
• Topics: documentation-tool, infrastructure-as-code, terraform, terraform-provider
• Language: Go
• Homepage: https://pkg.go.dev/github.com/shmokmt/tf-docs-finder
• Size: 149 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tf-docs-finder

This utility tool is designed to immediately open the documentation of a Terraform Provider from the command line.

## Installation

```

go install github.com/shmokmt/tf-docs-finder/cmd/tf-docs-finder@latest

```

## Usage

### AWS Provider

List resources:

```

tf-docs-finder aws

```

List data-sources

```

tf-docs-finder aws --type data-sources

```

Other providers have the same interface as well.

## Terraform Provider

Available following providers:

- [hashicorp/google](https://registry.terraform.io/providers/hashicorp/google/latest/docs)

- [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs)

- [integrations/github](https://registry.terraform.io/providers/integrations/github/latest/docs)

At present, it only supports latest version.