1 of 32

Commands

Usage

terrakube [command]

Commands

Click on each command to see more details

Command

Description

terrakube login

Authenticate with a Terrakube Server

Usage

Flags

Examples

terrakube logout

Logout from a Terrakube Server

Usage

terrakube logout [flags]

terrakube organization

This command consists of multiple subcommands to interact with organizations. It can be used to create, update, delete and list organizations.

Usage

terrakube organization [command]

Commands

Command

Description

Aliases

organization
org

organization list

List organizations

Usage

terrakube organization list [flags]

Flags

  -f, --filter string   Filter
  -h, --help            help for list

Examples

List all existing organizations

terrakube organization list

organization create

Create an organization

Usage

 terrakube organization create [flags]

Flags

  -d, --description string   Description of the new organization
  -h, --help                 help for create
  -n, --name string          Name of the new organization (required)

Examples

Create a new organization

terrakube organization create -n myorg -d "org description"

organization update

Update an organization

Usage

 terrakube organization update [flags]

Flags

  -d, --description string   Description of the organization
  -h, --help                 help for update
      --id string            Id of the organization (required)
  -n, --name string          Name of the organization

Examples

Update the description for an existing organization

terrakube organization update --id 38b6635a-d38e-46f2-a95e-d00a416de4fd -d "new description"

organization delete

Delete an organization

Usage

terrakube organization delete [flags]

Flags

  -h, --help        help for delete
      --id string   Id of the organization (required)

Examples

Delete an organization using id

terrakube organization delete --id 38b6635a-d38e-46f2-a95e-d00a416de4fd

terrakube team

This command consists of multiple subcommands to interact with teams. It can be used to create, update, delete and list teams.

Usage

Commands

Command

Description

Aliases

organization
org

team list

terrakube team list

List teams

Usage

terrakube team list [flags]

Flags

  -f, --filter string            Filter
  -h, --help                     help for list
      --organization-id string   Organization Id (required)

Examples

List all existing teams in an organization

terrakube team list --organization-id e5ad0642-f9b3-48b3-9bf4-35997febe1fb

team create

Create a Team

Usage

 terrakube team create [flags]

Flags

  -h, --help                     help for create
      --manage-module            Manage Module Permissions
      --manage-provider          Manage Provider Permissions
      --manage-workspace         Manage Workspaces Permissions
  -n, --name string              Name of the new Team (required)
      --organization-id string   Organization Id (required)

Examples

Create a new team

 terrakube team create --organization-id e5ad0642-f9b3-48b3-9bf4-35997febe1fb -n AZB_USER --manage-workspace=true --manage-module=true --manage-provider=true

team update

Usage

 terrakube team update [flags]

Flags

  -h, --help                     help for update
      --id string                Id of the Team (required)
      --manage-module            Manage Module Permissions
      --manage-provider          Manage Provider Permissions
      --manage-workspace         Manage Workspaces Permissions
  -n, --name string              Name of the Team
      --organization-id string   Organization Id (required)

Examples

Update the permissions for a Team

terrakube team update --organization-id e5ad0642-f9b3-48b3-9bf4-35997febe1fb --id 38b6635a-d38e-46f2-a95e-d00a416de4fd --manage-workspace=true --manage-module=false --manage-provider=true

team delete

Delete a team

Usage

terrakube team delete [flags]

Flags

  -h, --help                     help for delete
      --id string                Id of the Team (required)
      --organization-id string   Organization Id (required)

Examples

Delete a team

 terrakube team delete --organization-id e5ad0642-f9b3-48b3-9bf4-35997febe1fb --id 38b6635a-d38e-46f2-a95e-d00a416de4fd

terrakube workspace

This command consists of multiple subcommands to interact with workspaces. It can be used to create, update, delete and list workspaces.

Usage

terrakube workspace [command]

Commands

Command

Description

Aliases

workspace
wrk

workspace list

List workspaces

Usage

terrakube workspace list [flags]

Flags

  -f, --filter string            Filter
  -h, --help                     help for list
      --organization-id string   Organization Id (required)

Examples

List all existing workspaces in an Organization

terrakube workspace list --organization-id e5ad0642-f9b3-48b3-9bf4-35997febe1fb

workspace create

Create a workspace

Usage

Flags

Examples

Create a new workspace

workspace update

Update a workspace

Usage

Flags

Examples

Update Terraform version in workspace

workspace delete

Delete a workspace

Usage

 terrakube workspace delete [flags]

Flags

  -h, --help                     help for delete
      --id string                Id of the workspace (required)
      --organization-id string   Organization Id (required)

Examples

Delete a workspace

terrakube workspace delete --organization-id e5ad0642-f9b3-48b3-9bf4-35997febe1fb --id 38b6635a-d38e-46f2-a95e-d00a416de4fd

workspace variable

This command consists of multiple subcommands to interact with variables. It can be used to create, update, delete and list variables.

Usage

terrakube workspace variable [command]

Commands

Command

Description

Aliases

variable
var

variable list

List variables

Usage

terrakube workspace variable list [flags]

Flags

  -f, --filter string            Filter
  -h, --help                     help for list
      --organization-id string   Organization Id (required)
  -w, --workspace-id string      Workspace Id (required)

Examples

List all existing variables for a workspace

terrakube workspace variable list --organization-id e5ad0642-f9b3-48b3-9bf4-35997febe1fb -w 38b6635a-d38e-46f2-a95e-d00a416de4fd

terrakube variable

variable update

Update a variable

Usage

terrakube workspace variable update [flags]

Flags

  -c, --category string          Category of the variable. Valid values are TERRAFORM or ENV
  -d, --description string       Description of the variable
      --hcl                      Whether to evaluate the value of the variable as a string of HCL code. Has no effect for environment variables.
  -h, --help                     help for update
      --id string                Id of the variable (required)
  -k, --key string               Key of the variable
      --organization-id string   Organization Id (required)
  -s, --sensitive                Whether the value is sensitive. If true then the variable is written once and not visible thereafter.
  -v, --value string             Value of the variable
  -w, --workspace-id string      Workspace Id (required)

Examples

Update the value of the variable

terrakube workspace variable update --organization-id e5ad0642-f9b3-48b3-9bf4-35997febe1fb -w 38b6635a-d38e-46f2-a95e-d00a416de4fd --id 38b6635a-d38e-46f2-a95e-d00a416de4fd -v "new value"

variable delete

Delete a variable

Usage

terrakube workspace variable delete [flags]

Flags

  -h, --help                     help for delete
      --id string                Id of the variable (required)
      --organization-id string   Organization Id (required)
  -w, --workspace-id string      Workspace Id (required)

Examples

Delete a variable

terrakube workspace variable delete --organization-id e5ad0642-f9b3-48b3-9bf4-35997febe1fb  -w 38b6635a-d38e-46f2-a95e-d00a416de4fd --id 38b6635a-d38e-46f2-a95e-d00a416de4fd

variable create

Create a variable

Usage

terrakube workspace variable create [flags]

Flags

  -c, --category string          Category of the new variable. Valid values are TERRAFORM or ENV
  -d, --description string       Description of the new variable
      --hcl                      Whether to evaluate the value of the variable as a string of HCL code. Has no effect for environment variables.
  -h, --help                     help for create
  -k, --key string               Key of the new variable (required)
      --organization-id string   Organization Id (required)
  -s, --sensitive                Whether the value is sensitive. If true then the variable is written once and not visible thereafter.
  -v, --value string             Value for the new variable
  -w, --workspace-id string      Workspace Id (required)

Create a new variable

terrakube workspace variable create --organization-id e5ad0642-f9b3-48b3-9bf4-35997febe1fb -w 38b6635a-d38e-46f2-a95e-d00a416de4fd -k tag_name -v "Hola mundo" --hcl=false --sensitive=false --category TERRAFORM

terrakube job

This command consists of multiple subcommands to interact with jobs. It can be used to create and list teams.

Usage

terrakube job [command]

Commands

Command

Description

job list

List jobs

Usage

terrakube job list [flags]

Flags

  -f, --filter string            Filter
  -h, --help                     help for list
      --organization-id string   Organization Id (required)

Examples

List all existing jobs in an Organization

terrakube job list --organization-id e5ad0642-f9b3-48b3-9bf4-35997febe1fb

job create

Create a job

Usage

 terrakube job create [flags]

Flags

  -c, --command string           Command to execute: plan,apply,destroy (required)
  -h, --help                     help for create
      --organization-id string   Organization Id (required)
  -w, --workspace-id string      Workspace Id (required)

Examples

Create a new job

terrakube job create --organization-id e5ad0642-f9b3-48b3-9bf4-35997febe1fb -w e5ad0642-f9b3-48b3-9bf4-35997febe1fb  -c apply

terrakube module

This command consists of multiple subcommands to interact with modules. It can be used to create, update, delete and list modules.

Usage

terrakube module [command]

Commands

Command

Description

Aliases

module
mod

module list

List Modules

Usage

terrakube module list [flags]

Flags

  -f, --filter string            Filter
  -h, --help                     help for list
      --organization-id string   Organization Id (required)

Examples

List all existing modules in an Organization

terrakube module list --organization-id e5ad0642-f9b3-48b3-9bf4-35997febe1fb

module create

Create a module

Usage

 terrakube module create [flags]

Flags

  -d, --description string       Description of the new module
  -h, --help                     help for create
  -n, --name string              Name of the new module (required)
      --organization-id string   Organization Id (required)
  -p, --provider string          Provider of the new module
  -s, --source string            Source of the new module

Examples

Create a new module

terrakube module create --organization-id e5ad0642-f9b3-48b3-9bf4-35997febe1fb -n myModule -d "module description" -p azurerm -s https://github.com/AzBuilder/terraform-sample-repository.git

module update

Update a module

Usage

 terrakube module update [flags]

Flags

  -d, --description string       Description of the module
  -h, --help                     help for update
      --id string                Id of the module (required)
  -n, --name string              Name of the module
      --organization-id string   Organization Id (required)
  -p, --provider string          Provider of the module
  -s, --source string            Source of the module

Update the description of the module

terrakube module update --organization-id e5ad0642-f9b3-48b3-9bf4-35997febe1fb --id 38b6635a-d38e-46f2-a95e-d00a416de4fd -d "new description"

module delete

Delete a module

Usage

 terrakube module delete [flags]

Flags

  -h, --help                     help for delete
      --id string                Id of the module (required)
      --organization-id string   Organization Id (required)

Examples

Delete a module

terrakube module delete --organization-id e5ad0642-f9b3-48b3-9bf4-35997febe1fb --id 38b6635a-d38e-46f2-a95e-d00a416de4fd