kopia lustrzana https://github.com/linuxserver/docker-documentation
155 wiersze
9.0 KiB
Markdown
Executable File
155 wiersze
9.0 KiB
Markdown
Executable File
---
|
|
title: yq
|
|
---
|
|
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
|
<!-- Please read the https://github.com/linuxserver/docker-yq/blob/master/.github/CONTRIBUTING.md -->
|
|
|
|
[](https://linuxserver.io)
|
|
|
|
[](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!")
|
|
[](https://discord.gg/YWrKVTn "realtime support / chat with the community and the team.")
|
|
[](https://discourse.linuxserver.io "post on our community forum.")
|
|
[](https://fleet.linuxserver.io "an online web interface which displays all of our maintained images.")
|
|
[](https://github.com/linuxserver "view the source for all of our repositories.")
|
|
[](https://opencollective.com/linuxserver "please consider helping us by either donating or contributing to our budget")
|
|
|
|
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring:
|
|
|
|
* regular and timely application updates
|
|
* easy user mappings (PGID, PUID)
|
|
* custom base image with s6 overlay
|
|
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
|
|
* regular security updates
|
|
|
|
Find us at:
|
|
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
|
|
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
|
|
* [Discourse](https://discourse.linuxserver.io) - post on our community forum.
|
|
* [Fleet](https://fleet.linuxserver.io) - an online web interface which displays all of our maintained images.
|
|
* [GitHub](https://github.com/linuxserver) - view the source for all of our repositories.
|
|
* [Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget
|
|
|
|
# [linuxserver/yq](https://github.com/linuxserver/docker-yq)
|
|
|
|
[](https://github.com/linuxserver/docker-yq)
|
|
[](https://github.com/linuxserver/docker-yq/releases)
|
|
[](https://github.com/linuxserver/docker-yq/packages)
|
|
[](https://gitlab.com/Linuxserver.io/docker-yq/container_registry)
|
|
[](https://microbadger.com/images/linuxserver/yq "Get your own version badge on microbadger.com")
|
|
[](https://hub.docker.com/r/linuxserver/yq)
|
|
[](https://hub.docker.com/r/linuxserver/yq)
|
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-yq/job/master/)
|
|
|
|
[yq](https://github.com/kislyuk/yq): Command-line YAML/XML processor - jq wrapper for YAML and XML documents. This image includes `yq`, `jq`, and `xq`.
|
|
|
|
## Supported Architectures
|
|
|
|
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
|
|
|
Simply pulling `linuxserver/yq` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
|
|
|
|
The architectures supported by this image are:
|
|
|
|
| Architecture | Tag |
|
|
| :----: | --- |
|
|
| x86-64 | amd64-latest |
|
|
| arm64 | arm64v8-latest |
|
|
| armhf | arm32v7-latest |
|
|
|
|
## Usage
|
|
|
|
### Docker cli
|
|
|
|
```
|
|
docker run --rm \
|
|
-v "$PWD:$PWD" \
|
|
-w="$PWD" \
|
|
--entrypoint yq \
|
|
linuxserver/yq \
|
|
.foo.bar input.yml
|
|
```
|
|
You can replace the last line with any yq command and argument, which will be passed to yq inside the image.
|
|
|
|
```
|
|
docker run --rm \
|
|
-v "$PWD:$PWD" \
|
|
-w="$PWD" \
|
|
--entrypoint jq \
|
|
linuxserver/yq \
|
|
.foo.bar input.json
|
|
```
|
|
You can replace the last line with any jq command and argument, which will be passed to jq inside the image.
|
|
|
|
```
|
|
docker run --rm \
|
|
-v "$PWD:$PWD" \
|
|
-w="$PWD" \
|
|
--entrypoint xq \
|
|
linuxserver/yq \
|
|
.foo.bar input.xml
|
|
```
|
|
You can replace the last line with any xq command and argument, which will be passed to xq inside the image.
|
|
|
|
### Recommended method
|
|
|
|
We provide a very convenient script that allows the yq container to run as if it was installed natively:
|
|
```
|
|
sudo curl -L --fail https://raw.githubusercontent.com/linuxserver/docker-yq/master/run-yq.sh -o /usr/local/bin/yq
|
|
sudo chmod +x /usr/local/bin/yq
|
|
```
|
|
Running these two commands on your docker host once will let you issue commands such as `yq .foo.bar input.yml` and the yq container will do its job behind the scenes.
|
|
|
|
```
|
|
sudo curl -L --fail https://raw.githubusercontent.com/linuxserver/docker-yq/master/run-jq.sh -o /usr/local/bin/jq
|
|
sudo chmod +x /usr/local/bin/jq
|
|
```
|
|
Running these two commands on your docker host once will let you issue commands such as `jq .foo.bar input.json` and the jq container will do its job behind the scenes.
|
|
|
|
```
|
|
sudo curl -L --fail https://raw.githubusercontent.com/linuxserver/docker-yq/master/run-xq.sh -o /usr/local/bin/xq
|
|
sudo chmod +x /usr/local/bin/xq
|
|
```
|
|
Running these two commands on your docker host once will let you issue commands such as `xq .foo.bar input.xml` and the xq container will do its job behind the scenes.
|
|
|
|
## Docker Mods
|
|
[](https://mods.linuxserver.io/?mod=yq "view available mods for this container.")
|
|
|
|
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above.
|
|
|
|
|
|
## Support Info
|
|
|
|
* image version number
|
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/yq`
|
|
|
|
## Updating Info
|
|
|
|
### Via Docker Cli
|
|
* Update the image: `docker pull linuxserver/yq`
|
|
* You can also remove the old dangling images: `docker image prune`
|
|
|
|
|
|
## Building locally
|
|
|
|
If you want to make local modifications to these images for development purposes or just to customize the logic:
|
|
```
|
|
git clone https://github.com/linuxserver/docker-yq.git
|
|
cd docker-yq
|
|
docker build \
|
|
--no-cache \
|
|
--pull \
|
|
-t linuxserver/yq:latest .
|
|
```
|
|
|
|
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
|
|
```
|
|
docker run --rm --privileged multiarch/qemu-user-static:register --reset
|
|
```
|
|
|
|
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
|
|
|
|
## Versions
|
|
|
|
* **09.10.20:** - Fix run scripts evaluating `$` in cases where they should not (ex: inside single quotes). Please rerun the [Recommended method](https://github.com/linuxserver/docker-yq#recommended-method) install/setup commands.
|
|
* **07.10.20:** - Initial Release.
|