tfdocsfinder

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
• hashicorp/aws
• integrations/github

At present, it only supports latest version.

Documentation

Index

• Variables

Variables

var AwsDataSources = []string{}/* 593 elements not displayed */

var AwsResources = []string{}/* 1473 elements not displayed */

var GitHubDataSources = []string{
	"github_actions_environment_secrets",
	"github_actions_environment_variables",
	"github_actions_organization_oidc_subject_claim_customization_template",
	"github_actions_organization_public_key",
	"github_actions_organization_registration_token",
	"github_actions_organization_secrets",
	"github_actions_organization_variables",
	"github_actions_public_key",
	"github_actions_registration_token",
	"github_actions_repository_oidc_subject_claim_customization_template",
	"github_actions_secrets",
	"github_actions_variables",
	"github_app",
	"github_app_token",
	"github_branch",
	"github_branch_protection_rules",
	"github_codespaces_organization_public_key",
	"github_codespaces_organization_secrets",
	"github_codespaces_public_key",
	"github_codespaces_secrets",
	"github_codespaces_user_public_key",
	"github_codespaces_user_secrets",
	"github_collaborators",
	"github_dependabot_organization_public_key",
	"github_dependabot_organization_secrets",
	"github_dependabot_public_key",
	"github_dependabot_secrets",
	"github_enterprise",
	"github_external_groups",
	"github_ip_ranges",
	"github_issue_labels",
	"github_membership",
	"github_organization",
	"github_organization_custom_role",
	"github_organization_external_identities",
	"github_organization_ip_allow_list",
	"github_organization_team_sync_groups",
	"github_organization_teams",
	"github_organization_webhooks",
	"github_ref",
	"github_release",
	"github_repositories",
	"github_repository",
	"github_repository_autolink_references",
	"github_repository_branches",
	"github_repository_deploy_keys",
	"github_repository_deployment_branch_policies",
	"github_repository_environments",
	"github_repository_file",
	"github_repository_milestone",
	"github_repository_pull_request",
	"github_repository_pull_requests",
	"github_repository_teams",
	"github_repository_webhooks",
	"github_rest_api",
	"github_ssh_keys",
	"github_team",
	"github_tree",
	"github_user",
	"github_user_external_identity",
	"github_users",
}

var GitHubResources = []string{
	"github_actions_environment_secret",
	"github_actions_environment_variable",
	"github_actions_organization_oidc_subject_claim_customization_template",
	"github_actions_organization_permissions",
	"github_actions_organization_secret",
	"github_actions_organization_secret_repositories",
	"github_actions_organization_variable",
	"github_actions_repository_access_level",
	"github_actions_repository_oidc_subject_claim_customization_template",
	"github_actions_repository_permissions",
	"github_actions_runner_group",
	"github_actions_secret",
	"github_actions_variable",
	"github_app_installation_repositories",
	"github_app_installation_repository",
	"github_branch",
	"github_branch_default",
	"github_branch_protection",
	"github_branch_protection_v3",
	"github_codespaces_organization_secret",
	"github_codespaces_organization_secret_repositories",
	"github_codespaces_secret",
	"github_codespaces_user_secret",
	"github_dependabot_organization_secret",
	"github_dependabot_organization_secret_repositories",
	"github_dependabot_secret",
	"github_emu_group_mapping",
	"github_enterprise_actions_permissions",
	"github_enterprise_actions_runner_group",
	"github_enterprise_organization",
	"github_issue",
	"github_issue_label",
	"github_issue_labels",
	"github_membership",
	"github_organization_block",
	"github_organization_custom_role",
	"github_organization_project",
	"github_organization_ruleset",
	"github_organization_security_manager",
	"github_organization_settings",
	"github_organization_webhook",
	"github_project_card",
	"github_project_column",
	"github_release",
	"github_repository",
	"github_repository_autolink_reference",
	"github_repository_collaborator",
	"github_repository_collaborators",
	"github_repository_dependabot_security_updates",
	"github_repository_deploy_key",
	"github_repository_deployment_branch_policy",
	"github_repository_environment",
	"github_repository_environment_deployment_policy",
	"github_repository_file",
	"github_repository_milestone",
	"github_repository_project",
	"github_repository_pull_request",
	"github_repository_ruleset",
	"github_repository_tag_protection",
	"github_repository_topics",
	"github_repository_webhook",
	"github_team",
	"github_team_members",
	"github_team_membership",
	"github_team_repository",
	"github_team_settings",
	"github_team_sync_group_mapping",
	"github_user_gpg_key",
	"github_user_invitation_accepter",
	"github_user_ssh_key",
}

var GoogleDataSources = []string{}/* 341 elements not displayed */

var GoogleResources = []string{}/* 813 elements not displayed */