> For the complete documentation index, see [llms.txt](https://docs.terrakube.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.terrakube.io/2.34.0/readme.md).

# Introduction

Terrakube is an open source platform for running Terraform and OpenTofu remotely, with the collaboration, governance and private registry you would otherwise get from Terraform Enterprise, Scalr or env0. It runs on any Kubernetes cluster (or Docker Compose for evaluation) and works with the tools you already use.

### What you get

* **Workspaces and runs**: plans and applies run remotely from a git repository, the Terraform CLI, or the API, with approvals, scheduling, drift detection and structured, live output.
* **Governance**: organizations, projects, teams with role-based access, [OPA policy enforcement](/2.34.0/govern/policy-enforcement-opa.md), cost estimation and audit trails.
* **Private registry**: host your own Terraform modules and providers, or mirror the public registry.
* **Integrations**: GitHub, GitLab, Bitbucket and Azure DevOps, Slack and Teams notifications, OIDC dynamic credentials for AWS, Azure, GCP and Vault, and a CLI, API and Terraform provider to automate Terrakube itself.
* **Extensible**: custom workflows in [Terrakube Configuration Language](/2.34.0/set-up/organizations/templates.md) and actions that add buttons to the workspace UI.

### Where to start

| I want to...                              | Go to                                                                                                                                                                                                         |
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Try Terrakube on my machine               | [Getting Started](/2.34.0/getting-started/getting-started.md)                                                                                                                                                 |
| Deploy it for my team                     | [Deployment](/2.34.0/getting-started/deployment.md) and [User Management](/2.34.0/getting-started/user-management.md)                                                                                         |
| Run my first workspace                    | [Organizations](/2.34.0/set-up/organizations.md), then [Workspaces](/2.34.0/run-terraform/workspaces.md)                                                                                                      |
| Connect a git provider                    | [VCS Providers](/2.34.0/set-up/vcs-providers.md)                                                                                                                                                              |
| Use it from the Terraform CLI             | [CLI-driven Workflow](/2.34.0/run-terraform/workspaces/cli-driven-workflow.md)                                                                                                                                |
| Run it from CI/CD                         | [CI/CD Integration](/2.34.0/integrate/ci-cd-integration.md)                                                                                                                                                   |
| Automate Terrakube itself                 | [Terrakube CLI](/2.34.0/integrate/terrakube-cli.md), [API](/2.34.0/api-reference/getting-started.md) and the [Terraform provider](https://registry.terraform.io/providers/terrakube-io/terrakube/latest/docs) |
| Move from Terraform Cloud/Enterprise      | [Migrating to Terrakube](/2.34.0/reference/migrating-to-terrakube.md)                                                                                                                                         |
| Look up a setting or environment variable | [Configuration Reference](/2.34.0/reference/configuration.md)                                                                                                                                                 |
| Fix a problem                             | [Troubleshooting](/2.34.0/reference/troubleshooting.md)                                                                                                                                                       |
| Upgrade                                   | [Upgrading](/2.34.0/getting-started/upgrading.md)                                                                                                                                                             |
| See what changed                          | [Updates](/2.34.0/updates.md)                                                                                                                                                                                 |

### Sponsors

| Company                                                                                                                                                                                                                                                                                                     | Service                                                |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
| <p><img src="https://1229094460-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTN6M529qVFnas8hChf2y%2Fuploads%2Fgit-blob-68bdde85a4d6737a7b8f2eee74a36e7d139dc51d%2Fjetbrains.png?alt=media" alt="" data-size="original"></p><p><a href="https://jb.gg/OpenSource">JetBrains</a></p>   | For providing with free licenses to their great tools. |
| <p><img src="https://1229094460-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTN6M529qVFnas8hChf2y%2Fuploads%2Fgit-blob-bd033039e5819253f400bf74062bba8abcaa8964%2Fimage%20(482).png?alt=media" alt="" data-size="original"></p><p><a href="https://www.gitbook.com/">GitBook</a></p> | For providing us with free OSS Plan.                   |
| <p><img src="https://1229094460-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTN6M529qVFnas8hChf2y%2Fuploads%2Fgit-blob-79568fa3db4a3ce897b12ffb0bf4c38cd9720335%2Fimage%20(7).png?alt=media" alt="" data-size="original"></p><p><a href="https://www.docker.com/">Docker</a></p>     | For providing us with free OSS Plan.                   |
| <p><img src="https://1229094460-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTN6M529qVFnas8hChf2y%2Fuploads%2Fgit-blob-0ed46356a09d9c68e6a513f6abbd36b218c6a8da%2Ftuta_logo.svg?alt=media" alt="" data-size="original"></p><p><a href="https://tuta.com/">Tuta</a></p>               | For providing us with free email service.              |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.terrakube.io/2.34.0/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.