Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.xquik.com/llms.txt

Use this file to discover all available pages before exploring further.

Use the Terraform provider when Xquik resources need to live beside the rest of your infrastructure code.
Terraform Registry publication is pending. Until the provider appears in the registry, build it locally and use a Terraform CLI development override.

Install

Clone and build the provider:
git clone https://github.com/Xquik-dev/terraform-provider-x-twitter-scraper.git
cd terraform-provider-x-twitter-scraper
./scripts/build
Move the provider binary into a local plugin directory for your platform:
mkdir -p ~/.terraform.d/plugins/xquik-dev/x-twitter-scraper/0.2.0/darwin_arm64
mv terraform-provider-x-twitter-scraper ~/.terraform.d/plugins/xquik-dev/x-twitter-scraper/0.2.0/darwin_arm64/
Use the matching platform directory for your machine, such as linux_amd64, linux_arm64, darwin_amd64, darwin_arm64, or windows_amd64.

Configure Terraform

Add a development override to ~/.terraformrc:
provider_installation {
  dev_overrides {
    "Xquik-dev/x-twitter-scraper" = "/Users/you/.terraform.d/plugins/xquik-dev/x-twitter-scraper/0.2.0/darwin_arm64"
  }

  direct {}
}
Then declare the provider in your Terraform project:
terraform {
  required_providers {
    x-twitter-scraper = {
      source = "Xquik-dev/x-twitter-scraper"
    }
  }
}

provider "x-twitter-scraper" {
  api_key = var.xquik_api_key
}

Authenticate

Use variables or environment variables for credentials:
export X_TWITTER_SCRAPER_API_KEY="xq_YOUR_KEY_HERE"
export X_TWITTER_SCRAPER_BEARER_TOKEN="YOUR_OAUTH_TOKEN"

Error Handling

Provider errors surface through Terraform plan and apply output. REST API response semantics match the error handling guide.

State & Pagination

Terraform tracks resource state in your configured backend. Data sources and resources use the generated provider schema; review the generated docs in the provider repository before adding resources to production state.

Webhooks & References