Commands

This section provides complete documentation and usage examples for all resource subcommands in terrakube.

Available Command Domains

Command Domain	Description
Authentication	Authenticate (login) and end sessions (logout).
Organization	Manage Terrakube organizations.
Organization Tag	Create and list organization tags.
Team	Manage teams and organization role permissions.
Team Token	Generate, list, and delete team API access tokens.
Workspace	Manage workspaces, VCS sources, OpenTofu/Terraform execution settings.
Workspace Variable	Manage environment (ENV) and Terraform (TERRAFORM) workspace variables.
Workspace Tag	Associate tags with workspaces.
Workspace Schedule	Configure automated cron schedules and template triggers for workspaces.
Workspace Access	Configure team permissions on specific workspaces.
Workspace Action	Manage custom UI action buttons and execution criteria.
Workspace Address	Manage workspace remote state address mappings.
Notification Configuration	Manage Slack, Microsoft Teams, and custom Webhook notification integrations.
Notification Trigger	Define status triggers (completed, failed, etc.) for notification configurations.
Job	Trigger, inspect, and cancel Terraform/OpenTofu jobs (plan, apply, destroy).
Job Step	Inspect and update individual workflow execution steps.
Job History	View workspace execution history and state serial revisions.
Operations	Execute atomic JSON:API batch operation files (atomic:operations).
VCS	Connect and configure VCS providers (GitHub, GitLab, Bitbucket, Azure DevOps).
Webhook	Configure workspace VCS webhooks for automated triggering.
Webhook Event	Map branch patterns and event types to templates.
GitHub App Token	Manage GitHub App installation tokens.
Provider	Manage private registry providers.
Provider Version	Manage private provider release versions and protocols.
Provider Implementation	Manage architecture binaries, SHA256 checksums, and PGP signatures for providers.
Organization Module	Manage private registry Terraform modules.
Module Version	Manage release versions and git references for private modules.
Organization Variable	Manage global variables shared across all organization workspaces.
Organization Agent	Register and manage self-hosted agent execution endpoints.
SSH Key	Store SSH private keys for private VCS git repositories.
Template	Define reusable Terrakube TCL workflow flow templates.
Collection	Create reusable variable collections.
Collection Item	Add key/value items to collections.
Collection Reference	Link collections to target workspaces.
Project	Group workspaces into logical projects.
Project Access	Set team access permissions on projects.
Federated Identity	Configure OIDC federated identity providers.
Federated Claim	Define federated identity claims for workload identity authentication.