mirror of
https://github.com/opentffoundation/opentf.git
synced 2025-12-21 02:37:43 -05:00
a15a6c9657
Signed-off-by: Janos <86970079+janosdebugs@users.noreply.github.com> Signed-off-by: Damian Stasik <920747+damianstasik@users.noreply.github.com> Signed-off-by: Roman Grinovski <roman.grinovski@gmail.com> Co-authored-by: Damian Stasik <920747+damianstasik@users.noreply.github.com> Co-authored-by: Roman Grinovski <roman.grinovski@gmail.com>
50 lines
1.8 KiB
Plaintext
50 lines
1.8 KiB
Plaintext
---
|
|
description: The `tofu state` command is used for advanced state management.
|
|
---
|
|
|
|
# Command: state
|
|
|
|
The `tofu state` command is used for advanced state management.
|
|
As your OpenTofu usage becomes more advanced, there are some cases where
|
|
you may need to modify the [OpenTofu state](../../../language/state/index.mdx).
|
|
Rather than modify the state directly, the `tofu state` commands can
|
|
be used in many cases instead.
|
|
|
|
This command is a nested subcommand, meaning that it has further subcommands.
|
|
These subcommands are listed to the left.
|
|
|
|
## Usage
|
|
|
|
Usage: `tofu state <subcommand> [options] [args]`
|
|
|
|
Please click a subcommand to the left for more information.
|
|
|
|
## Remote State
|
|
|
|
The OpenTofu state subcommands all work with remote state just as if it
|
|
was local state. Reads and writes may take longer than normal as each read
|
|
and each write do a full network roundtrip. Otherwise, backups are still
|
|
written to disk and the CLI usage is the same as if it were local state.
|
|
|
|
## Backups
|
|
|
|
All `tofu state` subcommands that modify the state write backup
|
|
files. The path of these backup file can be controlled with `-backup`.
|
|
|
|
Subcommands that are read-only (such as [list](../../../cli/commands/state/list.mdx))
|
|
do not write any backup files since they aren't modifying the state.
|
|
|
|
Note that backups for state modification _can not be disabled_. Due to
|
|
the sensitivity of the state file, OpenTofu forces every state modification
|
|
command to write a backup file. You'll have to remove these files manually
|
|
if you don't want to keep them around.
|
|
|
|
## Command-Line Friendly
|
|
|
|
The output and command-line structure of the state subcommands is
|
|
designed to be usable with Unix command-line tools such as grep, awk,
|
|
and similar PowerShell commands.
|
|
|
|
For advanced filtering and modification, we recommend piping OpenTofu
|
|
state subcommands together with other command line tools.
|