https://github.com/Phil-Factor/PSYaml

A Powershell module to convert YAML documents to and from PowerShell objects
https://github.com/Phil-Factor/PSYaml

Last synced: 9 days ago
JSON representation

A Powershell module to convert YAML documents to and from PowerShell objects

• Host: GitHub
• URL: https://github.com/Phil-Factor/PSYaml
• Owner: Phil-Factor
• License: mit
• Created: 2016-09-05T16:01:02.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2021-07-23T09:23:29.000Z (over 3 years ago)
• Last Synced: 2024-05-23T00:32:55.563Z (7 months ago)
• Language: PowerShell
• Size: 256 KB
• Stars: 88
• Watchers: 9
• Forks: 32
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - Phil-Factor/PSYaml - A Powershell module to convert YAML documents to and from PowerShell objects (PowerShell)

README

        
# PSYaml

## Build Status

|Branch | Status |

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

|Master |[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/pezhore/PSYaml?branch=master&svg=true)](https://ci.appveyor.com/project/pezhore/PSYaml/branch/master)|



## Introduction

This module will help users convert from/to YAML. For more information see [the documentation](./Documentation.md) or the [legacy documentation](./Legacy_Documentation.adoc).

Please note that the **Master** branch has the latest, ready-for-production version. The **release/stage** branch is the holding ground for master merges where integration testing will take place. Other branches with active development will be denoted by having a prefix ( **feature/**, **bugfix/**, **release/**, etc) followed by an unique identifier. Nothing is merged into **release/stage** branch without code review, and only code that passes testing in the **release/stage** branch will be merged into **master**.

## Features

* Fancy Logo

* Bundled binary

* Pester Testing

## ToDo

* Clean up documentation

## Example Usage

```PowerShell

import-module psyaml

$yamlString = @"

anArray:

- 1

- 2

- 3

nested:

  array:

  - this

  - is

  - an

  - array

hello: world

"@

$YamlObject = ConvertFrom-YAML $yamlString

ConvertTo-YAML $YamlObject

```

## Contact Information

Author: Phil-Factor ([email protected])

## Release Notes

|  Version  | Change Log                                                        |

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

|  1.0.3    | Closed the open YAML file if error occurs in it during parsing    |

|  1.0.2    | Reformated several sections for readability, added pester tests   |

|  1.0.1    | Converted single psm1 file to multiple public/private functions   |

## Installation

### One time setup

* Download/clone the repository

* Copy the PSYaml folder to a module path (e.g. `$env:USERPROFILE\Documents\WindowsPowerShell\Modules\`)

* Alternatively, in the PS-PSYaml folder use PSDeploy (`Invoke-PSDeploy -Path .\PSDeploy\`)

### Automated Install

* Assuming you have PowerShell v5 and a Nuget Repository configured, use the built in Module management (`Install-Module PSYaml`)

## Import the module.

`Import-Module PSYaml    #Alternatively, Import-Module \\Path\To\PSYaml`

## Get commands in the module

`Get-Command -Module PSYaml`

## Get help

`Get-Help ConvertFrom-Yaml -Full`

`Get-Help about_PSYaml`