Skip to content

Binary wrapper for yq

License

Notifications You must be signed in to change notification settings

gethinode/yq-bin

Repository files navigation

yq-bin

Binary wrapper for yq

npm package Last commit Issues Pulls License

AboutPrerequisitesInstallationCreditsLicense

About

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

Prerequisites

This package requires npm. You are recommended to install Node.js, which includes npm.

Installation

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

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. 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:

License

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