• Docs
  • Using Terrateam
  • Commands

Terrateam Commands

Terrateam commands can be issued by commenting on GitHub Pull Requests

terrateam plan

The terrateam plan command executes the plan Workflow against changes in a pull request.

All changes

Plan all changes

terrateam plan

Target a Directory

Plan a specific directory by using the dir implicit tag:

terrateam plan dir:directory-name

Target a Workspace

Plan a specific directory and workspace combination by using the dir and workspace implicit tags:

terrateam plan dir:directory-name workspace:workspace-name

Target a Tag Query

Plan a specific Tag Query

terrateam plan <tag-query>

See Tags documentation for Tag Query details.

terrateam apply

The terrateam apply command executes the apply Workflow against a stored plan file for changes in a pull request.

All plans

Apply all plan files

terrateam apply

Target a Directory

Apply a specific directory by using the dir implicit tag:

terrateam apply dir:directory-name

Target a Workspace

Apply a specific directory and workspace combination by using the dir and workspace implicit tags:

terrateam apply dir:directory-name workspace:workspace-name

Target a Tag Query

Apply a specific Tag Query

terrateam apply <tag-query>

See Tags documentation for Tag Query details.

terrateam apply-force

Run an Apply even if the change has not passed Apply Requirements.

terrateam apply-force <optional-tag-query>
🚫

This is a dangerous operation. See Access Control to limit access.

terrateam apply-autoapprove

Execute a Plan and Apply in the same execution skipping approvals.

terrateam apply-autoapprove <optional-tag-query>
🚫

This is a dangerous operation. See Access Control to limit access.

terrateam unlock

Release any locks a pull request owns.

terrateam unlock
🚫

This is a dangerous operation. See Access Control to limit access.

terrateam feedback

Send us feedback straight to our inbox.

terrateam feedback <msg>