hcp waypoint templates update reference

Command: hcp waypoint templates update

The hcp waypoint templates update command lets you update existing HCP Waypoint templates.

Usage

$ hcp waypoint templates update --name=NAME [Optional Flags]

Examples

Update an HCP Waypoint template:

$ hcp waypoint templates update -n=my-template \
  -s="My Template Summary" \
  -d="My Template Description" \
  -readme-markdown-template-file "README.tpl" \
  --tfc-project-name="my-tfc-project" \
  --tfc-project-id="prj-123456 \
  -l="label1" \
  -l="label2"

Required flags

• -n, --name=NAME - The name of the template to be updated.

Optional flags

• -d, --description=DESCRIPTION - The description of the template.

• -l, --label=LABEL [Repeatable] - A label to apply to the template.

• --readme-markdown-template-file=README_MARKDOWN_TEMPLATE_FILE_PATH - The file containing the README markdown template.

• -s, --summary=SUMMARY - The summary of the template.

• --tf-agent-pool-id=TF_AGENT_POOL_ID - The ID of the Terraform agent pool to use for running Terraform operations. This is only applicable when the execution mode is set to 'agent'.

• --tf-execution-mode=TF_EXECUTION_MODE - The execution mode of the HCP Terraform workspaces for applications using this template.

• --tfc-project-id=TFC_PROJECT_ID - The ID of the Terraform Cloud project where applications using this template will be created.

• --tfc-project-name=TFC_PROJECT_NAME - The name of the Terraform Cloud project where applications using this template will be created.

• --variable-options-file=VARIABLE_OPTIONS_FILE - The file containing the HCL definition of Variable Options.