Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yannoff/jaml
Dead-simple JSON/YAML converter utility
https://github.com/yannoff/jaml
json json-to-yaml yaml yaml-to-json
Last synced: about 2 months ago
JSON representation
Dead-simple JSON/YAML converter utility
- Host: GitHub
- URL: https://github.com/yannoff/jaml
- Owner: yannoff
- License: mit
- Created: 2023-02-07T10:03:51.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-10T00:07:03.000Z (10 months ago)
- Last Synced: 2024-03-11T00:26:08.147Z (10 months ago)
- Topics: json, json-to-yaml, yaml, yaml-to-json
- Language: PHP
- Homepage:
- Size: 344 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JAML
Easy-to-use JSON <=> YAML converter
[](https://github.com/yannoff/jaml/releases/latest "Latest stable release")
[](https://github.com/yannoff/jaml/blob/master/LICENSE "MIT License")
## Usage
_Input format is detected automatically, hence:_
- [YAML input will be converted to JSON](#converting-yaml-to-json)
- [JSON input will be converted to YAML](#converting-json-to-yaml)
### Converting YAML to JSON
```bash
# The classic way:
jaml
# or using piped standard input:
cat file.yaml | jaml
```
### Converting JSON to YAML
```bash
# The classic way:
jaml
# or using piped standard input:
cat file.json | jaml
```
### Examples
_**Converting remote JSON contents over https**_
```bash
jaml https://repo.packagist.org/packages/list.json?vendor=yannoff
```
_Output:_
```yaml
packageNames:
- yannoff/collections
- yannoff/composer-dotenv-handler
- yannoff/console
- yannoff/handyman
- yannoff/lumiere-ui
- yannoff/lumiere-utils
- yannoff/symfony-boilerplate
- yannoff/y-a-m-l
- yannoff/yamltools
```
_**Converting a YAML file contents**_
```bash
jaml composer.yaml
```
_Output:_
```json
{
"name": "yannoff/jaml",
"description": "Easy-to-use JSON <=> YAML converter",
"type": "project",
"license": "MIT",
"authors": [
{
"name": "Yannoff",
"homepage": "https://github.com/yannoff"
}
],
"autoload": {
"psr-4": {
"Yannoff\\Jaml\\": "src/"
}
},
"require": {
"yannoff/console": "^2.0",
"yannoff/yamltools": "^1.5"
}
}
```
### Available options
**`-i, --interactive`**
*Run in interactive mode*
**`-h, --help`**
*Display help message*
**`-v, --verbose`**
*Increase the verbosity of jaml output*
**`--version`**
*Display version and exit*
## Installation
### Requirements
- [`php`](https://www.php.net/) 5.5+ or [`PAW`](https://github.com/yannoff/p-a-w)
### Quick install
Get the latest release and install it
```bash
curl -Lo /usr/bin/jaml https://github.com/yannoff/jaml/releases/latest/download/jaml
chmod +x /usr/bin/jaml
```
:bulb: _The `/usr/bin/jaml` path is just an example, fell free to replace by any custom binary file path._
### Checksums
Some checksum files are available to verify the `jaml` binary integrity:
- [jaml.md5](https://github.com/yannoff/jaml/releases/latest/download/jaml.md5)
- [jaml.sha384](https://github.com/yannoff/jaml/releases/latest/download/jaml.sha384)
_Here is an example using PHP_
```php
echo hash_file('sha384', 'https://github.com/yannoff/jaml/releases/latest/download/jaml');
```
## Credits
_**JAML** leverages [offenbach](https://github.com/yannoff/offenbach) for PHP dependency management._
Compiled as a PHAR self-executable using [PHP Code Compiler](https://github.com/yannoff/phpcc).
## License
Licensed under the [MIT License](LICENSE).