| [ | |
| { "heading": "OpenTofu CLI" }, | |
| { "title": "Overview", "path": "cli/index" }, | |
| { "title": "Basic CLI Features", "path": "cli/commands/index" }, | |
| { | |
| "title": "Initializing Working Directories", | |
| "routes": [ | |
| { "title": "Overview", "path": "cli/init/index" }, | |
| { "title": "<code>init</code>", "path": "cli/commands/init" }, | |
| { "title": "<code>get</code>", "path": "cli/commands/get" } | |
| ] | |
| }, | |
| { | |
| "title": "Provisioning Infrastructure", | |
| "routes": [ | |
| { "title": "Overview", "path": "cli/run/index" }, | |
| { "title": "<code>plan</code>", "path": "cli/commands/plan" }, | |
| { "title": "<code>apply</code>", "path": "cli/commands/apply" }, | |
| { "title": "<code>destroy</code>", "path": "cli/commands/destroy" } | |
| ] | |
| }, | |
| { | |
| "title": "Authenticating", | |
| "routes": [ | |
| { "title": "Overview", "path": "cli/auth/index" }, | |
| { "title": "<code>login</code>", "path": "cli/commands/login" }, | |
| { "title": "<code>logout</code>", "path": "cli/commands/logout" } | |
| ] | |
| }, | |
| { | |
| "title": "Writing and Modifying Code", | |
| "routes": [ | |
| { "title": "Overview", "path": "cli/code/index" }, | |
| { "title": "<code>console</code>", "path": "cli/commands/console" }, | |
| { "title": "<code>fmt</code>", "path": "cli/commands/fmt" }, | |
| { "title": "<code>validate</code>", "path": "cli/commands/validate" } | |
| ] | |
| }, | |
| { | |
| "title": "Inspecting Infrastructure", | |
| "routes": [ | |
| { "title": "Overview", "path": "cli/inspect/index" }, | |
| { "title": "<code>graph</code>", "path": "cli/commands/graph" }, | |
| { "title": "<code>output</code>", "path": "cli/commands/output" }, | |
| { "title": "<code>show</code>", "path": "cli/commands/show" }, | |
| { | |
| "title": "<code>state list</code>", | |
| "path": "cli/commands/state/list" | |
| }, | |
| { | |
| "title": "<code>state show</code>", | |
| "path": "cli/commands/state/show" | |
| } | |
| ] | |
| }, | |
| { | |
| "title": "Importing Infrastructure", | |
| "routes": [ | |
| { "title": "Overview", "path": "cli/import/index" }, | |
| { | |
| "title": "<code>import</code>", | |
| "path": "cli/commands/import" | |
| }, | |
| { "title": "Usage Tips", "path": "cli/import/usage" }, | |
| { | |
| "title": "Resource Importability", | |
| "path": "cli/import/importability" | |
| } | |
| ] | |
| }, | |
| { | |
| "title": "Manipulating State", | |
| "routes": [ | |
| { "title": "Overview", "path": "cli/state/index" }, | |
| { | |
| "title": "Resource Addressing", | |
| "path": "cli/state/resource-addressing" | |
| }, | |
| { "title": "<code>state</code>", "path": "cli/commands/state/index" }, | |
| { | |
| "title": "Inspecting State", | |
| "routes": [ | |
| { "title": "Overview", "path": "cli/state/inspect" }, | |
| { | |
| "title": "<code>state list</code>", | |
| "path": "cli/commands/state/list" | |
| }, | |
| { | |
| "title": "<code>state show</code>", | |
| "path": "cli/commands/state/show" | |
| }, | |
| { | |
| "title": "<code>refresh</code>", | |
| "path": "cli/commands/refresh" | |
| } | |
| ] | |
| }, | |
| { | |
| "title": "Forcing Re-creation (Tainting)", | |
| "routes": [ | |
| { "title": "Overview", "path": "cli/state/taint" }, | |
| { | |
| "title": "<code>taint</code>", | |
| "path": "cli/commands/taint" | |
| }, | |
| { | |
| "title": "<code>untaint</code>", | |
| "path": "cli/commands/untaint" | |
| } | |
| ] | |
| }, | |
| { | |
| "title": "Moving Resources", | |
| "routes": [ | |
| { "title": "Overview", "path": "cli/state/move" }, | |
| { | |
| "title": "<code>state mv</code>", | |
| "path": "cli/commands/state/mv" | |
| }, | |
| { | |
| "title": "<code>state rm</code>", | |
| "path": "cli/commands/state/rm" | |
| }, | |
| { | |
| "title": "<code>state replace-provider</code>", | |
| "path": "cli/commands/state/replace-provider" | |
| } | |
| ] | |
| }, | |
| { | |
| "title": "Disaster Recovery", | |
| "routes": [ | |
| { | |
| "title": "Overview", | |
| "path": "cli/state/recover" | |
| }, | |
| { | |
| "title": "<code>state pull</code>", | |
| "path": "cli/commands/state/pull" | |
| }, | |
| { | |
| "title": "<code>state push</code>", | |
| "path": "cli/commands/state/push" | |
| }, | |
| { | |
| "title": "<code>force-unlock</code>", | |
| "path": "cli/commands/force-unlock" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "title": "Managing Workspaces", | |
| "routes": [ | |
| { "title": "Overview", "path": "cli/workspaces/index" }, | |
| { | |
| "title": "<code>workspace</code>", | |
| "routes": [ | |
| { "title": "Overview", "path": "cli/commands/workspace/index" }, | |
| { | |
| "title": "<code>workspace list</code>", | |
| "path": "cli/commands/workspace/list" | |
| }, | |
| { | |
| "title": "<code>workspace select</code>", | |
| "path": "cli/commands/workspace/select" | |
| }, | |
| { | |
| "title": "<code>workspace new</code>", | |
| "path": "cli/commands/workspace/new" | |
| }, | |
| { | |
| "title": "<code>workspace delete</code>", | |
| "path": "cli/commands/workspace/delete" | |
| }, | |
| { | |
| "title": "<code>workspace show</code>", | |
| "path": "cli/commands/workspace/show" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "title": "Managing Plugins", | |
| "routes": [ | |
| { "title": "Overview", "path": "cli/plugins/index" }, | |
| { "title": "Plugin Signing", "path": "cli/plugins/signing" }, | |
| { | |
| "title": "<code>providers</code>", | |
| "path": "cli/commands/providers" | |
| }, | |
| { | |
| "title": "<code>version</code>", | |
| "path": "cli/commands/version" | |
| }, | |
| { | |
| "title": "<code>providers lock</code>", | |
| "path": "cli/commands/providers/lock" | |
| }, | |
| { | |
| "title": "<code>providers mirror</code>", | |
| "path": "cli/commands/providers/mirror" | |
| }, | |
| { | |
| "title": "<code>providers schema</code>", | |
| "path": "cli/commands/providers/schema" | |
| } | |
| ] | |
| }, | |
| { | |
| "title": "CLI Configuration", | |
| "routes": [ | |
| { "title": "Overview", "path": "cli/config/index" }, | |
| { "title": "CLI Configuration", "path": "cli/config/config-file" }, | |
| { | |
| "title": "Environment Variables", | |
| "path": "cli/config/environment-variables" | |
| } | |
| ] | |
| }, | |
| { | |
| "title": "Using Cloud Backend", | |
| "routes": [ | |
| { "title": "Overview", "path": "cli/cloud/index" }, | |
| { "title": "Cloud Backend Settings", "path": "cli/cloud/settings" }, | |
| { | |
| "title": "Initializing and Migrating", | |
| "path": "cli/cloud/migrating" | |
| }, | |
| { | |
| "title": "Command Line Arguments", | |
| "path": "cli/cloud/command-line-arguments" | |
| } | |
| ] | |
| }, | |
| { | |
| "title": "Alphabetical List of Commands", | |
| "routes": [ | |
| { "title": "Overview", "path": "cli/commands/index" }, | |
| { "title": "<code>apply</code>", "path": "cli/commands/apply" }, | |
| { "title": "<code>console</code>", "path": "cli/commands/console" }, | |
| { "title": "<code>destroy</code>", "path": "cli/commands/destroy" }, | |
| { "title": "<code>env</code>", "path": "cli/commands/env" }, | |
| { "title": "<code>fmt</code>", "path": "cli/commands/fmt" }, | |
| { | |
| "title": "<code>force-unlock</code>", | |
| "path": "cli/commands/force-unlock" | |
| }, | |
| { "title": "<code>get</code>", "path": "cli/commands/get" }, | |
| { "title": "<code>graph</code>", "path": "cli/commands/graph" }, | |
| { "title": "<code>import</code>", "path": "cli/commands/import" }, | |
| { "title": "<code>init</code>", "path": "cli/commands/init" }, | |
| { "title": "<code>login</code>", "path": "cli/commands/login" }, | |
| { "title": "<code>logout</code>", "path": "cli/commands/logout" }, | |
| { "title": "<code>output</code>", "path": "cli/commands/output" }, | |
| { "title": "<code>plan</code>", "path": "cli/commands/plan" }, | |
| { "title": "<code>providers</code>", "path": "cli/commands/providers" }, | |
| { | |
| "title": "<code>providers lock</code>", | |
| "path": "cli/commands/providers/lock" | |
| }, | |
| { | |
| "title": "<code>providers mirror</code>", | |
| "path": "cli/commands/providers/mirror" | |
| }, | |
| { | |
| "title": "<code>providers schema</code>", | |
| "path": "cli/commands/providers/schema" | |
| }, | |
| { "title": "<code>refresh</code>", "path": "cli/commands/refresh" }, | |
| { "title": "<code>show</code>", "path": "cli/commands/show" }, | |
| { "title": "<code>state</code>", "path": "cli/commands/state/index" }, | |
| { | |
| "title": "<code>state list</code>", | |
| "path": "cli/commands/state/list" | |
| }, | |
| { "title": "<code>state mv</code>", "path": "cli/commands/state/mv" }, | |
| { | |
| "title": "<code>state pull</code>", | |
| "path": "cli/commands/state/pull" | |
| }, | |
| { | |
| "title": "<code>state push</code>", | |
| "path": "cli/commands/state/push" | |
| }, | |
| { | |
| "title": "<code>state replace-provider</code>", | |
| "path": "cli/commands/state/replace-provider" | |
| }, | |
| { "title": "<code>state rm</code>", "path": "cli/commands/state/rm" }, | |
| { | |
| "title": "<code>state show</code>", | |
| "path": "cli/commands/state/show" | |
| }, | |
| { "title": "<code>taint</code>", "path": "cli/commands/taint" }, | |
| { | |
| "title": "<code>test (deprecated)</code>", | |
| "path": "cli/commands/test" | |
| }, | |
| { "title": "<code>untaint</code>", "path": "cli/commands/untaint" }, | |
| { "title": "<code>validate</code>", "path": "cli/commands/validate" }, | |
| { "title": "<code>version</code>", "path": "cli/commands/version" }, | |
| { | |
| "title": "<code>workspace</code>", | |
| "path": "cli/commands/workspace/index" | |
| }, | |
| { | |
| "title": "<code>workspace list</code>", | |
| "path": "cli/commands/workspace/list" | |
| }, | |
| { | |
| "title": "<code>workspace select</code>", | |
| "path": "cli/commands/workspace/select" | |
| }, | |
| { | |
| "title": "<code>workspace new</code>", | |
| "path": "cli/commands/workspace/new" | |
| }, | |
| { | |
| "title": "<code>workspace delete</code>", | |
| "path": "cli/commands/workspace/delete" | |
| }, | |
| { | |
| "title": "<code>workspace show</code>", | |
| "path": "cli/commands/workspace/show" | |
| } | |
| ] | |
| }, | |
| { | |
| "title": "Alphabetical list of commands", | |
| "hidden": true, | |
| "routes": [ | |
| { "title": "Overview", "path": "cli/commands/index" }, | |
| { "title": "apply", "path": "cli/commands/apply" }, | |
| { "title": "console", "path": "cli/commands/console" }, | |
| { "title": "destroy", "path": "cli/commands/destroy" }, | |
| { "title": "env", "path": "cli/commands/env" }, | |
| { "title": "fmt", "path": "cli/commands/fmt" }, | |
| { "title": "force-unlock", "path": "cli/commands/force-unlock" }, | |
| { "title": "get", "path": "cli/commands/get" }, | |
| { "title": "graph", "path": "cli/commands/graph" }, | |
| { "title": "import", "path": "cli/commands/import" }, | |
| { "title": "init", "path": "cli/commands/init" }, | |
| { "title": "login", "path": "cli/commands/login" }, | |
| { "title": "logout", "path": "cli/commands/logout" }, | |
| { "title": "output", "path": "cli/commands/output" }, | |
| { "title": "plan", "path": "cli/commands/plan" }, | |
| { | |
| "title": "providers", | |
| "routes": [ | |
| { "title": "providers", "path": "cli/commands/providers" }, | |
| { "title": "providers lock", "path": "cli/commands/providers/lock" }, | |
| { | |
| "title": "providers mirror", | |
| "path": "cli/commands/providers/mirror" | |
| }, | |
| { | |
| "title": "providers schema", | |
| "path": "cli/commands/providers/schema" | |
| } | |
| ] | |
| }, | |
| { "title": "refresh", "path": "cli/commands/refresh" }, | |
| { "title": "show", "path": "cli/commands/show" }, | |
| { | |
| "title": "state", | |
| "routes": [ | |
| { "title": "state", "path": "cli/commands/state" }, | |
| { "title": "state list", "path": "cli/commands/state/list" }, | |
| { "title": "state mv", "path": "cli/commands/state/mv" }, | |
| { "title": "state pull", "path": "cli/commands/state/pull" }, | |
| { "title": "state push", "path": "cli/commands/state/push" }, | |
| { | |
| "title": "state replace-provider", | |
| "path": "cli/commands/state/replace-provider" | |
| }, | |
| { "title": "state rm", "path": "cli/commands/state/rm" }, | |
| { "title": "state show", "path": "cli/commands/state/show" } | |
| ] | |
| }, | |
| { "title": "taint", "path": "cli/commands/taint" }, | |
| { | |
| "title": "test (deprecated)", | |
| "path": "cli/commands/test", | |
| "hidden": true | |
| }, | |
| { "title": "untaint", "path": "cli/commands/untaint" }, | |
| { "title": "validate", "path": "cli/commands/validate" }, | |
| { "title": "version", "path": "cli/commands/version" }, | |
| { | |
| "title": "workspace", | |
| "routes": [ | |
| { | |
| "title": "workspace", | |
| "path": "cli/commands/workspace" | |
| }, | |
| { "title": "workspace list", "path": "cli/commands/workspace/list" }, | |
| { | |
| "title": "workspace select", | |
| "path": "cli/commands/workspace/select" | |
| }, | |
| { "title": "workspace new", "path": "cli/commands/workspace/new" }, | |
| { | |
| "title": "workspace delete", | |
| "path": "cli/commands/workspace/delete" | |
| }, | |
| { "title": "workspace show", "path": "cli/commands/workspace/show" } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "title": "Installation", | |
| "hidden": true, | |
| "routes": [ | |
| { | |
| "title": "APT Packages for Debian and Ubuntu", | |
| "path": "cli/install/apt" | |
| }, | |
| { | |
| "title": "Yum Packages for Red Hat Enterprise Linux, Fedora, and Amazon Linux", | |
| "path": "cli/install/yum" | |
| } | |
| ] | |
| } | |
| ] |