new-terraform-provider

OverviewHistoryStatsSecurity

npx skills add hashicorp/terraform-agent-kit --skill new-terraform-provider

Documentation

SKILL.md

npx skills add ...

Documentation

SKILL.md

Use this when scaffolding a new Terraform provider with the Plugin Framework: workspace layout, go module setup, provider server main.go, and a provider.go with schema and Configure. Also use when a user wants to start building a provider for a new API or asks how to begin a terraform-provider-* project.

This repo is now called hashicorp/agent-skills. Both names install the same content, but the install count here only covers this one.

npx skills add hashicorp/terraform-agent-kit --skill new-terraform-provider

Documentation

SKILL.mdView source

To scaffold a new Terraform provider with Plugin Framework:

If I am already in a Terraform provider workspace, then confirm that I want to create a new workspace. If I do not want to create a new workspace, then skip all remaining steps.
Create a new workspace root directory. The root directory name should be prefixed with "terraform-provider-". Perform all subsequent steps in this new workspace.
Initialize a new Go module.
Run go get -u github.com/hashicorp/terraform-plugin-framework@latest.
Write a main.go file that follows the example.
Write an internal/provider/provider.go file that follows the example. Rename the demo provider, the DEMO_* environment variables, and the authentication attributes to match the target API.
Remove TODO comments from main.go and provider.go.
Run go mod tidy
Run go build -o /dev/null
Run go test ./... The scaffold resolves credentials as explicit config with environment variable fallback. To grow that into a full credential provider chain (shared credentials files, profiles, platform identity, configure-time validation), use the provider-configuration skill (if available). To add the first resource or data source, use the provider-resources skill (if available).

npx skills add hashicorp/terraform-agent-kit --skill new-terraform-provider

Documentation

SKILL.md

This repo is now called hashicorp/agent-skills. Both names install the same content, but the install count here only covers this one.

npx skills add hashicorp/terraform-agent-kit --skill new-terraform-provider

Documentation

SKILL.mdView source

To scaffold a new Terraform provider with Plugin Framework:

If I am already in a Terraform provider workspace, then confirm that I want to create a new workspace. If I do not want to create a new workspace, then skip all remaining steps.
Create a new workspace root directory. The root directory name should be prefixed with "terraform-provider-". Perform all subsequent steps in this new workspace.
Initialize a new Go module.
Run go get -u github.com/hashicorp/terraform-plugin-framework@latest.
Write a main.go file that follows the example.
Write an internal/provider/provider.go file that follows the example. Rename the demo provider, the DEMO_* environment variables, and the authentication attributes to match the target API.
Remove TODO comments from main.go and provider.go.
Run go mod tidy
Run go build -o /dev/null
Run go test ./... The scaffold resolves credentials as explicit config with environment variable fallback. To grow that into a full credential provider chain (shared credentials files, profiles, platform identity, configure-time validation), use the provider-configuration skill (if available). To add the first resource or data source, use the provider-resources skill (if available).