Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Terraform CLI to remove -ing, group commands #35656

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update Terraform CLI to remove -ing, group commands #35656

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c58e5c
update Terraform CLI to remove -ing, group commands
im2nguyen Aug 29, 2024
917b708
fix typo
im2nguyen Aug 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
198 changes: 102 additions & 96 deletions website/data/cli-nav-data.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,29 @@
[
{ "heading": "Terraform CLI" },
{ "title": "Overview", "path": "" },
{ "title": "Basic CLI Features", "href": "/cli/commands" },
{ "title": "Basic CLI features", "href": "/cli/commands" },
{
"title": "Initializing Working Directories",
"title": "Configure CLI",
"routes": [
{ "title": "Overview", "path": "config" },
{ "title": "CLI configuration", "path": "config/config-file" },
{
"title": "Environment variables",
"path": "config/environment-variables"
}
]
},
{ "heading": "Fundamentals" },
{
"title": "Initialize working directories",
"routes": [
{ "title": "Overview", "path": "init" },
{ "title": "<code>init</code>", "href": "/cli/commands/init" },
{ "title": "<code>get</code>", "href": "/cli/commands/get" }
]
},
{
"title": "Provisioning Infrastructure",
"title": "Provision infrastructure",
"routes": [
{ "title": "Overview", "path": "run" },
{ "title": "<code>plan</code>", "href": "/cli/commands/plan" },
Expand All @@ -20,15 +32,7 @@
]
},
{
"title": "Authenticating",
"routes": [
{ "title": "Overview", "path": "auth" },
{ "title": "<code>login</code>", "href": "/cli/commands/login" },
{ "title": "<code>logout</code>", "href": "/cli/commands/logout" }
]
},
{
"title": "Writing and Modifying Code",
"title": "Write and modify configuration",
"routes": [
{ "title": "Overview", "path": "code" },
{ "title": "<code>console</code>", "href": "/cli/commands/console" },
Expand All @@ -44,8 +48,34 @@
}
]
},

{ "heading": "HCP Terraform" },
{
"title": "Use HCP Terraform",
"routes": [
{ "title": "Overview", "path": "cloud" },
{ "title": "HCP Terraform Settings", "path": "cloud/settings" },
{
"title": "Initialize and migrate",
"path": "cloud/migrating"
},
{
"title": "Command line arguments",
"path": "cloud/command-line-arguments"
}
]
},
{
"title": "Authenticate to HCP Terraform",
"routes": [
{ "title": "Overview", "path": "auth" },
{ "title": "<code>login</code>", "href": "/cli/commands/login" },
{ "title": "<code>logout</code>", "href": "/cli/commands/logout" }
]
},
{ "heading": "Advanced" },
{
"title": "Inspecting Infrastructure",
"title": "Inspect resources",
"routes": [
{ "title": "Overview", "path": "inspect" },
{ "title": "<code>graph</code>", "href": "/cli/commands/graph" },
Expand All @@ -62,31 +92,66 @@
]
},
{
"title": "Importing Infrastructure",
"title": "Import resources",
"routes": [
{ "title": "Overview", "path": "import" },
{
"title": "<code>import</code>",
"href": "/cli/commands/import"
},
{ "title": "Usage Tips", "path": "import/usage" },
{ "title": "Usage tips", "path": "import/usage" },
{
"title": "Resource Importability",
"path": "import/importability"
}
]
},
{
"title": "Manipulating State",
"title": "Test configuration",
"routes": [
{ "title": "Overview", "path": "test" },
{ "title": "<code>test<code>", "href": "/cli/commands/test"}
]
},

{
"title": "Manage providers",
"routes": [
{ "title": "Overview", "path": "plugins" },
{ "title": "Plugin signing", "path": "plugins/signing" },
{
"title": "<code>providers</code>",
"href": "/cli/commands/providers"
},
{
"title": "<code>version</code>",
"href": "/cli/commands/version"
},
{
"title": "<code>providers lock</code>",
"href": "/cli/commands/providers/lock"
},
{
"title": "<code>providers mirror</code>",
"href": "/cli/commands/providers/mirror"
},
{
"title": "<code>providers schema</code>",
"href": "/cli/commands/providers/schema"
}
]
},
{
"title": "Manipulate state",
"routes": [
{ "title": "Overview", "path": "state" },
{
"title": "Resource Addressing",
"title": "Resource addressing",
"path": "state/resource-addressing"
},
{ "title": "<code>state</code>", "href": "/cli/commands/state" },
{
"title": "Inspecting State",
"title": "Inspect state",
"routes": [
{ "title": "Overview", "path": "state/inspect" },
{
Expand All @@ -104,7 +169,7 @@
]
},
{
"title": "Forcing Re-creation (Tainting)",
"title": "Forcing re-creation (tainting)",
"routes": [
{ "title": "Overview", "path": "state/taint" },
{
Expand All @@ -118,7 +183,7 @@
]
},
{
"title": "Moving Resources",
"title": "Move resources",
"routes": [
{ "title": "Overview", "path": "state/move" },
{
Expand All @@ -136,7 +201,7 @@
]
},
{
"title": "Disaster Recovery",
"title": "Disaster recovery",
"routes": [
{
"title": "Overview",
Expand All @@ -159,7 +224,20 @@
]
},
{
"title": "Managing Workspaces",
"title": "Automate Terraform",
"routes": [
{
"title": "Run Terraform in automation",
"href": "/terraform/tutorials/automation/automate-terraform"
},
{
"title": "GitHub Actions",
"href": "/terraform/tutorials/automation/github-actions"
}
]
},
{
"title": "Manage workspaces",
"routes": [
{ "title": "Overview", "path": "workspaces" },
{
Expand Down Expand Up @@ -190,81 +268,9 @@
}
]
},
{ "divider": true },
{
"title": "Managing Plugins",
"routes": [
{ "title": "Overview", "path": "plugins" },
{ "title": "Plugin Signing", "path": "plugins/signing" },
{
"title": "<code>providers</code>",
"href": "/cli/commands/providers"
},
{
"title": "<code>version</code>",
"href": "/cli/commands/version"
},
{
"title": "<code>providers lock</code>",
"href": "/cli/commands/providers/lock"
},
{
"title": "<code>providers mirror</code>",
"href": "/cli/commands/providers/mirror"
},
{
"title": "<code>providers schema</code>",
"href": "/cli/commands/providers/schema"
}
]
},
{
"title": "CLI Configuration",
"routes": [
{ "title": "Overview", "path": "config" },
{ "title": "CLI Configuration", "path": "config/config-file" },
{
"title": "Environment Variables",
"path": "config/environment-variables"
}
]
},
{
"title": "Using HCP Terraform",
"routes": [
{ "title": "Overview", "path": "cloud" },
{ "title": "HCP Terraform Settings", "path": "cloud/settings" },
{
"title": "Initializing and Migrating",
"path": "cloud/migrating"
},
{
"title": "Command Line Arguments",
"path": "cloud/command-line-arguments"
}
]
},
{
"title": "Testing Terraform",
"routes": [
{ "title": "Overview", "path": "test" },
{ "title": "<code>test<code>", "href": "/cli/commands/test"}
]
},
{
"title": "Automating Terraform",
"routes": [
{
"title": "Running Terraform in Automation",
"href": "https://learn.hashicorp.com/tutorials/terraform/automate-terraform?in=terraform/automation&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS"
},
{
"title": "GitHub Actions",
"href": "https://learn.hashicorp.com/tutorials/terraform/github-actions?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS"
}
]
},
{
"title": "Alphabetical List of Commands",
"title": "Alphabetical list of commands",
"routes": [
{ "title": "Overview", "href": "/cli/commands" },
{ "title": "<code>apply</code>", "href": "/cli/commands/apply" },
Expand Down
4 changes: 2 additions & 2 deletions website/docs/cli/auth/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
page_title: Authentication - Terraform CLI
page_title: Authenticate CLI to HCP Terraform - Terraform CLI
description: >-
Documentation about the login and logout commands that help automate getting
an API token for your HCP Terraform account.
---

# CLI Authentication
# Authenticate CLI to HCP Terraform

> **Hands-on:** Try the [Authenticate the CLI with HCP Terraform](/terraform/tutorials/cloud/cloud-login?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial.

Expand Down
6 changes: 3 additions & 3 deletions website/docs/cli/cloud/command-line-arguments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
page_title: Command Line Arguments
description: Command Line Arguments
page_title: Command line arguments
description: Command line arguments
---

# Command Line Arguments
# Command line arguments

When your configuration includes a `cloud` block, commands that
make local modifications to Terraform state and then push them back up to the remote workspace
Expand Down
18 changes: 11 additions & 7 deletions website/docs/cli/cloud/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
page_title: Using HCP Terraform - Terraform CLI
page_title: Use HCP Terraform - Terraform CLI
description: >-
Learn how to use HCP Terraform and Terraform Enterprise on the command line with the Terraform CLI.
---

# Using HCP Terraform with Terraform CLI
# Use HCP Terraform with Terraform CLI

The Terraform CLI integration with HCP Terraform lets you use HCP Terraform and Terraform Enterprise on the command line. In the documentation HCP Terraform instructions also apply to Terraform Enterprise, except where explicitly stated.

Expand All @@ -14,14 +14,18 @@ Using HCP Terraform through the command line is called the [CLI-driven run workf

Workspaces can also be configured for local execution, in which case HCP Terraform only stores state. In this mode, HCP Terraform behaves just like a standard state backend.

-> **Note:** The CLI integration is available in Terraform 1.1.0 and later, and Terraform Enterprise 202201-1 and later. Previous versions can use the [`remote` backend](/terraform/language/settings/backends/remote). Refer to [Migrating from the remote
<Note>

The CLI integration is available in Terraform 1.1.0 and later, and Terraform Enterprise 202201-1 and later. Previous versions can use the [`remote` backend](/terraform/language/settings/backends/remote). Refer to [Migrating from the remote
backend](/terraform/cli/cloud/migrating) for details about switching to the CLI integration.

## Documentation Summary
</Note>

- [HCP Terraform Settings](/terraform/cli/cloud/settings) documents the `cloud` block that you must add to your configuration to enable HCP Terraform support.
- [Initializing and Migrating](/terraform/cli/cloud/migrating) describes
## Documentation summary

- [HCP Terraform settings](/terraform/cli/cloud/settings) documents the `cloud` block that you must add to your configuration to enable HCP Terraform support.
- [Initialize and migrate](/terraform/cli/cloud/migrating) describes
how to start using HCP Terraform with a working directory that already has state data.
- [Command Line Arguments](/terraform/cli/cloud/command-line-arguments) lists the Terraform command flags that are specific to using Terraform with HCP Terraform.
- [Command Line arguments](/terraform/cli/cloud/command-line-arguments) lists the Terraform command flags that are specific to using Terraform with HCP Terraform.

Refer to the [CLI-driven Run Workflow](/terraform/cloud-docs/run/cli) for more details about how to use HCP Terraform from the command line.
Loading
Loading