# Yq

Yq is a containerized command-line YAML processor that reads, writes, and queries YAML documents, letting homelab users automate configuration edits in scripts, CI pipelines, and container workflows. It is open source and self-hosted, installable on Docker Hub and ZimaOS.

Canonical page: https://ourlocalhost.com/app/3940/yq

## Description

yq is a containerized command-line YAML processor that reads, writes, and queries YAML documents, letting homelab users automate configuration edits in scripts, CI pipelines, and container workflows.

## Platform availability

Available on 1 of 10 platforms: ZimaOS.

## Health score

61/100 (Good), based on 3 of 4 factors.
- Maintained: 100 (last commit 23 days ago)
- Popular: 21 (10 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)

## Links

- Docker Hub: https://hub.docker.com/r/linuxserver/yq
- GitHub: https://github.com/linuxserver/docker-yq
- ZimaOS: https://github.com/bigbeartechworld/big-bear-casaos/tree/master/Apps/yq

## Common questions

### Does yq support every jq operation?

No. yq does not yet support everything jq does, but it supports the most common operations.

### Can yq syntax change depending on the installation method?

Yes. The syntax can differ depending on whether yq is installed from source or pip.

### What file formats can yq process?

It processes YAML, JSON, XML, CSV, TOML, HCL, and properties files.

### How do I prevent yq from returning a filtered subset during updates?

Wrap the left-hand expression in brackets. Without brackets, yq first filters by the selection and then updates only the filtered result.

---
Source: Our Local Host (https://ourlocalhost.com/app/3940/yq), the self-hosted and open-source app directory.
