> 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/user-guide/terrakube-cli.md).

# Terrakube CLI

`terrakube` brings Terrakube infrastructure automation, workspace lifecycle management, organization management, private registry, access control, and dynamic provider credentials directly to your terminal.

***

## Guide Index

* [**Installation**](/user-guide/terrakube-cli/install.md): Download official release binaries for Linux, macOS, and Windows or build from source.
* [**Getting Started**](/user-guide/terrakube-cli/getting-started.md): Login/Logout setup, authentication options, configuration files, global flags, and complete shell quickstart script.
* [**Command Reference**](/user-guide/terrakube-cli/commands.md): Complete detailed CRUD reference for all CLI resources and subcommands.

***

## CLI Features

* **JSON:API Native Integration**: Full CRUD support for Organizations, Workspaces, Teams, Projects, Private Registry (Modules & Providers), Templates, Collections, Agents, SSH Keys, VCS, and OIDC Federated Identity.
* **Flexible Output Formats**: Render output as formatted tables (`--output table`), clean JSON (`--output json`), YAML (`--output yaml`), or TSV (`--output tsv`).
* **Flexible Parent Scopes**: Identify parent entities via UUID flags (e.g. `--organization-id`) or human-readable names (e.g. `--organization` / `-o`).
* **Automation Ready**: Fully scriptable via environment variables (`TERRAKUBE_API_URL`, `TERRAKUBE_TOKEN`, `TERRAKUBE_ORGANIZATION`).


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.terrakube.io/user-guide/terrakube-cli.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.