Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mbode/terraform-state-mover

Refactoring Terraform code has never been easier.
https://github.com/mbode/terraform-state-mover

terraform

Last synced: about 1 month ago
JSON representation

Refactoring Terraform code has never been easier.

Host: GitHub
URL: https://github.com/mbode/terraform-state-mover
Owner: mbode
License: mit
Created: 2019-08-04T12:59:04.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-07-05T04:48:03.000Z (over 1 year ago)
Last Synced: 2024-11-15T03:45:06.922Z (about 1 month ago)
Topics: terraform
Language: Go
Homepage:
Size: 723 KB
Stars: 146
Watchers: 3
Forks: 8
Open Issues: 5
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Go Report Card](https://goreportcard.com/badge/github.com/mbode/terraform-state-mover)](https://goreportcard.com/report/github.com/mbode/terraform-state-mover)

[![Actions Status](https://github.com/mbode/terraform-state-mover/workflows/Check/badge.svg)](https://github.com/mbode/terraform-state-mover/actions)

[![codecov](https://codecov.io/gh/mbode/terraform-state-mover/branch/master/graph/badge.svg)](https://codecov.io/gh/mbode/terraform-state-mover)

[![License](https://img.shields.io/github/license/mbode/terraform-state-mover)](https://github.com/mbode/terraform-state-mover/blob/master/LICENSE)

[![Release](https://img.shields.io/github/v/release/mbode/terraform-state-mover)](https://github.com/mbode/terraform-state-mover/releases/latest)

# Terraform State Mover

Helps refactoring terraform code by offering an interactive prompt for the [`terraform state mv`](https://www.terraform.io/docs/commands/state/mv.html) command.

## Installation

Using [homebrew](https://brew.sh/):

```bash

brew install mbode/tap/terraform-state-mover

```

Alternatively, get a pre-built binary from the [latest release](https://github.com/mbode/terraform-state-mover/releases/latest) or build it yourself using

```bash

go get github.com/mbode/terraform-state-mover

```

## Usage

```bash

terraform-state-mover # inside a Terraform root directory

```

Extra arguments after a `--` are passed to the `terraform plan` call. This makes the following possible:

```bash

terraform-state-mover -- -var key=value  # set variables

terraform-state-mover -- -var-file=variables.tfvars  # use variable files

terraform-state-mover -- -refresh=false  # skip state refresh

terraform-state-mover -- -parallelism=50  # speed up plan by using more concurrent operations

```

*Hint:*

If terraform-state-mover is used with the [Google Cloud Platform provider](https://www.terraform.io/docs/providers/google/index.html) and remote state, it is recommended to use `--delay=2s`, otherwise API rate limits error might occur.

## Key mapping

| Key | Action    |

|-----|-----------|

| ⏎   | Select    |

| ↓   | Next      |

| ↑   | Previous  |

| →   | Page Down |

| ←   | Page Up   |

## Demo

![](demo.gif)

## Terraform version compatibility

| < 0.10.1 | 0.10.1…8 | 0.11.0…15 | 0.12.0…31 | 0.13.0…7 | 0.14.0…11 | 0.15.0…5 | 1.0.0…11 | 1.1.0…9 | 1.2.0…2 |

|:--------:|:--------:|:---------:|:---------:|:--------:|:---------:|:--------:|:--------:|:-------:|:-------:|

| ✗        | ✓        | ✓         | ✓         | ✓        | ✓         | ✓        |    ✓     |    ✓    |    ✓    |

## Contributing

Pull requests are welcome. Please make sure to update tests as appropriate.

## License

[MIT](https://choosealicense.com/licenses/mit/)

## Similar tools

 - [tfautomv](https://github.com/busser/tfautomv) - Generate Terraform `moved` blocks automatically for painless refactoring