Skip to content

Latest commit

 

History

History
118 lines (74 loc) · 4.67 KB

README.md

File metadata and controls

118 lines (74 loc) · 4.67 KB
Raw

YARM CLI GitHub release

YARM CLI is a console application to help ARM template authoring in YAML. Even though ARM templates officially only support JSON format, YAML as a superset of JSON is much better for writing ARM templates that have complex structure.

Download YARM CLI

You can download YARM CLI at the release page.

Getting Started

With YARM CLI, you can easily convert your YAML documents to JSON and/or vice versa.

Basic Command

The command is dead simple.

yarm -i [INPUT_FILE_NAME] -o [OUTPUT_FILE_NAME]

YAML to JSON

yarm -i [YAML_FILE_NAME]

If no output name is specified, it stores the same location of the input file with .json extension. You can even convert YAML from the Internet.

yarm -i https://raw.githubusercontent.com/TeamYARM/YARM-CLI/master/samples/azuredeploy.yaml

If no output name is specified, it stores the current location using the same file name with .json extension.

JSON to YAML

yarm -i [JSON_FILE_NAME]

If no output name is specified, it stores the same location of the input file with .yaml extension. You can even convert JSON from the Internet.

yarm -i https://raw.githubusercontent.com/TeamYARM/YARM-CLI/master/samples/azuredeploy.json

Integrating CI Pipeline

YARM CLI works really well with any continuous integration (CI) pipeline.

Install the Latest Release

If you want to integrate YARM CLI with your preferred CI pipeline, you can use this PowerShell script block to download and install.

# Download the PowerShell script from GitHub
$script = Invoke-WebRequest https://raw.githubusercontent.com/TeamYARM/YARM-CLI/master/Download-Latest.ps1

# Create argument list
# - RUNTIME: Runtime environment for YARM CLI. Possible values are win-x64, linux-x64, osx-x64. Default is win-x64.
# - RUNPATH: Location where YARM CLI is downloaded and installed. Default is the current location where the script is running.
$argList = "[RUNTIME]", "[RUNPATH]"

# Run the script
Invoke-Command -ScriptBlock ([scriptblock]::Create($script.Content)) -ArgumentList $argList

Convert Multiple Files

There are chances you have multiple JSON or YAML files to deal with. You can use this PowerShell script block for it.

$directory = "[ARM_TEMPLATE_DIRECTORY]"
$yarmpath = "[YARM_CLI_DIRECTORY]\yarm.cmd"
$targetdir = "[TARGET_DIRECTORY]"

& $yarmpath --version

# #1. Convert ARM templates written in YAML to JSON
Get-ChildItem -Path $directory -Recurse | `
    Where-Object { $_.Name -like "*.yaml" } | `
    ForEach {
        & $yarmpath -i $_.FullName -o "$targetdir\$($_.Name)".Replace(".yaml", ".json")
    }

# #2. Convert ARM templates written in YAML to JSON
Get-ChildItem -Path $directory -Recurse -Include *.yaml | `
    ForEach {
        & $yarmpath -i $_.FullName -o "$targetdir\$($_.Name)".Replace(".yaml", ".json")
    }

Contribution

Your contributions are always welcome! All your work should be done in your forked repository. Once you finish your work with corresponding tests, please send us a pull request onto our dev branch for review.

License

YARM CLI is released under MIT License

The MIT License (MIT)

Copyright (c) 2018 Team YARM

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.