Skip to main content

GraphQL Query for Module Instructions Within the Registry

Feature Requests

After confirming with support, this is not currently possible.

We would like to be able to query GraphQL for module instructions so they are the most accurate and get the potential for mistakes or outdated info. This query would integrate our backend automation (that is currently using queries) with our Developer Portal. It would build out skeleton .tf files based on what resources a user chooses by using a query in the portal to grab instructions and populate the .tf files per resource.

Problem
Automation
Status: ✅ Completed2 comments

Log in to comment and vote

Comments2

  • Black Breeze

    •

    May 8, 2025

    Oh, this is totally possible:

    module(id: ID) {
  latest {
    metadata {
      readme
    }
  }
}

    You can play with our schema here.

    • Crimson Prairie

      •

      Jun 17, 2025

      Thank you, Marcin. I was looking for an easy way to query and get the formatted content contained in the module instructions generated by Spacelift from the “Show Instructions”. It appears to be a user event I can’t quite replicate.