Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MertSenel/Hcl2PS
PowerShell Module to Wrap Hcl2Json CLI tool for Easy distribution of PowerShell cmdlets to Parse HCL Files
https://github.com/MertSenel/Hcl2PS
Last synced: 3 months ago
JSON representation
PowerShell Module to Wrap Hcl2Json CLI tool for Easy distribution of PowerShell cmdlets to Parse HCL Files
- Host: GitHub
- URL: https://github.com/MertSenel/Hcl2PS
- Owner: MertSenel
- License: apache-2.0
- Created: 2023-03-18T01:05:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-01T01:32:19.000Z (6 months ago)
- Last Synced: 2024-06-01T02:36:17.034Z (6 months ago)
- Language: PowerShell
- Size: 55.3 MB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE.txt
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- jimsghstars - MertSenel/Hcl2PS - PowerShell Module to Wrap Hcl2Json CLI tool for Easy distribution of PowerShell cmdlets to Parse HCL Files (PowerShell)
README
[](https://github.com/MertSenel/Hcl2PS/actions/workflows/ci_pwsh.yml)[](https://github.com/MertSenel/Hcl2PS/actions/workflows/ci_powershell.yml)[](https://github.com/MertSenel/Hcl2PS/actions/workflows/publish-module.yml)[](https://github.com/MertSenel/Hcl2PS/actions/workflows/validate-module-install.yml)
[](https://opensource.org/licenses/Apache-2.0)[](https://badge.fury.io/gh/MertSenel%2FHcl2PS)[](https://www.powershellgallery.com/packages/Hcl2PS)[](https://www.powershellgallery.com/packages/Hcl2PS)
# Hcl2PS
PowerShell Module to Wrap Hcl2Json CLI tool for Easy distribution of PowerShell cmdlets to Parse HCL Files
Thanks to @tmccombs for the original CLI tool, you can see the original code of the CLI tool in below urls.
hcl2Json Project Url: [https://github.com/tmccombs/hcl2json](https://github.com/tmccombs/hcl2json)
hcl2Json Project License: [https://github.com/tmccombs/hcl2json/blob/main/LICENSE](https://github.com/tmccombs/hcl2json/blob/main/LICENSE)
## Installation
`Hcl2PS` is aimed to be cross-platform and tested with best effort on Windows, Linux, and MacOS.
Getting started with `Hcl2PS` is easy. Simply install and Import the module from the gallery using the following commands:
```powershell
Install-Module -Name Hcl2PS
Import-Module -Name Hcl2PS
```
## Usage
### Standard Usage - PowerShell Object Output
The cmdlet `ConvertFrom-Hcl` accepts input in two ways, you can either pass a filepath to the Hcl file you wish to convert to a terraform object, or you can pass the contents of the file via pipeline input.
`ConvertFrom-Hcl -Path .\main.tf`
`Get-Content .\main.tf -Raw | ConvertFrom-Hcl`
As an output, the Cmdlet will return a Powershell object which has the properties mapped from the HCL syntax file's contents.
#### Examples
### JSON String Output
The cmdlet also supports a new -AsJson switch that allows you to return the output as a JSON string instead of a PowerShell object. This can be useful if you need to work with the data in JSON format or want to verify that the conversion to JSON is correct.
`ConvertFrom-Hcl -Path .\main.tf -AsJson`
`Get-Content .\main.tf -Raw | ConvertFrom-Hcl -AsJson`
When using the -AsJson switch, the Cmdlet will return a JSON string that represents the same data as the standard PowerShell object output.
These features provide flexibility in how you work with HCL files, allowing
you to choose the output format that best suits your needs.
#### Examples
## Contributions & Issues
Contributions are welcomed, please raise a Pull Request with your proposed modifications if you wish to make any changes.
If you find an Issue and wish to report it, please use the Issues section.
## License
Apache Licensed, please see [license](LICENSE.txt) for details.