https://github.com/gideaworx/terraform-exporter
https://github.com/gideaworx/terraform-exporter
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/gideaworx/terraform-exporter
- Owner: gideaworx
- License: mit
- Created: 2023-03-02T00:39:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-30T15:26:02.000Z (almost 2 years ago)
- Last Synced: 2024-08-09T06:54:53.776Z (8 months ago)
- Language: Go
- Size: 84 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- jimsghstars - gideaworx/terraform-exporter - (Go)
README
# Terraform Exporter
 
The `terraform-exporter` CLI is a pluggable tool that supports exporting resources
you have already created into [Terraform HCL][1] files. Plugins determine what
resources should be exported and how to export them, as well as a terraform
provider file. This tool generates a shell script to `terraform import` those
resources to be used later.
By default, the tool does not know how to export anything, and leaves that up to
the plugins to do. Plugins are hosted by registries, and a [default registry][2]
is configured in the tool.
## Installing
### Homebrew (MacOS and Linux)
```bash
$ brew install gideaworx/tap/terraform-exporter
```
### Prebuilt Binaries
Visit the [releases][3] page.
### From source
```bash
$ go install github.com/gideaworx/terraform-exporter@latest
```
## Using
```
Usage: terraform-exporter
Flags:
-h, --help Show context-sensitive help.
-v, --version Show the version and quit
Commands:
export ...
Export data to terraform files
install-plugin (install,i)
Install a plugin
remove-plugin (remove,rm)
Uninstall a plugin
update-plugin (update,up)
Update a plugin
help (h)
Show help for a plugin's exporter command
list-plugins (ls)
List installed plugins
list-commands (lc)
List commands provided by installed plugins
registry show-catalog (ls)
List all installed plugin registries
registry available-plugins
List all plugins available in a registry
registry add
Add a registry from which plugins can be installed
registry remove (rm)
Remove a registry from the local catalog
Run "terraform-exporter --help" for more information on a command.
```
## Developing a plugin
Follow the guides in the [plugin repository][4]
## License
`terraform-exporter` is released under the [MIT](./LICENSE) license.
## Contributing
Pull requests are welcome! All contributors are bound by the [Code of Conduct][5].
Before opening a pull request, please open an [issue][6] so it can be triaged.
Please ensure, to the best of your ability, that the issue actually lies within the
CLI itself and not a plugin before opening an issue.
[1]: https://terraform.io
[2]: https://plugin-registry.gideaworx.io
[3]: ../../releases
[4]: https://github.com/gideaworx/terraform-exporter-plugin
[5]: CODE_OF_CONDUCT.md
[6]: ../../issues/new