https://github.com/gethinode/yq-bin

Binary wrapper for yq
https://github.com/gethinode/yq-bin

Last synced: about 2 months ago
JSON representation

Binary wrapper for yq

• Host: GitHub
• URL: https://github.com/gethinode/yq-bin
• Owner: gethinode
• License: mit
• Created: 2024-01-07T13:14:31.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-29T16:03:47.000Z (6 months ago)
• Last Synced: 2024-11-06T07:48:36.103Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 626 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# yq-bin



    Binary wrapper for yq

    






    

        

    

    

        

    

    

        

    

    

        

    

    

        

    





  About •

  Prerequisites •

  Installation •

  Credits •

  License



## About

[yq][yq_repo] is a lightweight and portable command-line YAML, JSON, and XML processor. It is written and maintained by [Mike Farah][mikefarah]. Inspired by [hugo-bin][hugo-bin], this package publishes yq as [npm][npm] binary.

## Prerequisites

This package requires `npm`. You are recommended to install [Node.js][nodejs], which includes `npm`.

## Installation

Run the following command to install `yq-bin` as development dependency in your current project.

```bash

npm install @gethinode/yq-bin --save-dev

```

## Usage

Use `npx yq` to run the embedded `yq` binary. When `npx` is unavailable, you can run `./node_modules/.bin/yq` instead.

## Notes

This package is derived from [fenneclab/hugo-bin][hugo-bin]. The underlying code does not recognize computers with Apple Silicon properly. Instead, an Intel-based binary is used, which may affect performance.

## Credits

This package is based on the following repository:

- [fenneclab/hugo-bin][hugo-bin]

## License

The `yq-bin` codebase is released under the [MIT license][license].

[nodejs]: https://nodejs.org

[npm]: https://www.npmjs.com

[hugo-bin]: https://github.com/fenneclab/hugo-bin

[mikefarah]: https://github.com/mikefarah

[yq_repo]: https://github.com/mikefarah/yq

[license]: https://github.com/gethinode/hinode/blob/main/LICENSE