| منصة | أمر |
|---|
| Ubuntu/Debian | wget https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64 -O /usr/local/bin/yq && chmod +x /usr/local/bin/yq |
| Ubuntu (PPA) | sudo add-apt-repository ppa:rmescandon/yq && sudo apt update && sudo apt install yq |
| macOS (Homebrew) | brew install yq |
| macOS (MacPorts) | sudo port install yq |
| Windows (Chocolatey) | choco install yq |
| Windows (Scoop) | scoop install yq |
| Snap | snap install yq |
| Go | go install github.com/mikefarah/yq/v4@latest |
| Docker | docker run --rm -v "${PWD}":/workdir mikefarah/yq |
| Alpine Linux | apk add yq |
| Arch Linux | yay -S yq |
| Verify Installation | yq --version |
| أمر | وصف |
|---|
yq '.' file.yaml | عرض الملف YAML بالكامل (طباعة جميلة) |
yq '.name' file.yaml | اقرأ قيمة حقل محدد |
yq '.metadata.name' file.yaml | قراءة الحقل المتداخل باستخدام تدوين النقطة |
yq '.items[0]' file.yaml | الوصول إلى العنصر الأول من مصفوفة |
yq '.items[*]' file.yaml | الوصول إلى جميع عناصر المصفوفة |
yq '.items[]' file.yaml | تصفح عناصر المصفوفة |
yq '.items[].name' file.yaml | استخراج حقل محدد من جميع عناصر المصفوفة |
yq '.items[-1]' file.yaml | الوصول إلى العنصر الأخير من مصفوفة |
yq '.items[1:3]' file.yaml | شريحة المصفوفة (العناصر 1 و 2) |
| `cat file.yaml \ | yq ‘.spec’` |
yq -r '.name' file.yaml | قم بإخراج السلسلة الخام (بدون علامات اقتباس) |
| `yq ‘.items \ | length’ file.yaml` |
yq 'keys' file.yaml | قائمة بجميع المفاتيح الرئيسية |
| `yq ’.[] \ | keys’ file.yaml` |
| أمر | وصف |
|---|
yq '.name = "new-value"' file.yaml | تحديث حقل (يطبع على stdout) |
yq -i '.name = "new-value"' file.yaml | تحديث الحقل في نفس المكان (يعدل الملف) |
yq '.spec.replicas = 3' file.yaml | قم بتحديث القيمة المتداخلة |
yq '.items[0].name = "updated"' file.yaml | تحديث عنصر المصفوفة |
yq '.newField = "value"' file.yaml | إنشاء حقل جديد |
yq '.metadata.labels.env = "prod"' file.yaml | إنشاء حقل متداخل |
yq 'del(.fieldName)' file.yaml | احذف حقل |
yq 'del(.metadata.annotations)' file.yaml | احذف الحقل المتداخل |
yq 'del(.items[0])' file.yaml | حذف عنصر المصفوفة |
yq '.items += {"name": "new"}' file.yaml | إلحاق بالمصفوفة |
yq '.items = []' file.yaml | مصفوفة واضحة |
yq '.count += 1' file.yaml | زيادة القيمة الرقمية |
yq '.total = .price * .quantity' file.yaml | العمليات الحسابية |
| أمر | وصف |
|---|
| `yq ‘.items[] \ | select(.kind == “Pod”)’ file.yaml` |
| `yq ‘.items[] \ | select(.kind == “Pod” and .status == “Running”)’ file.yaml` |
| `yq ‘.items[] \ | select(.kind == “Pod” or .kind == “Service”)’ file.yaml` |
| `yq ‘.items[] \ | اختر(.الاسم \ |
| `yq ‘.items[] \ | select(has(“metadata”))’ file.yaml` |
| `yq ‘.items[] \ | select(.replicas > 3)’ file.yaml` |
| `yq ‘.items[] \ | اختر(.العلامات \ |
| `yq ‘.items[] \ | select(.name != null)’ file.yaml` |
| `yq ’.[] \ | select(tag == “!!str”)’ file.yaml` |
| أمر | وصف |
|---|
| `yq ‘.items \ | = sort_by(.name)’ file.yaml` |
| `yq ‘.items \ | = sort_by(.metadata.creationTimestamp)’ file.yaml` |
| `yq ‘.items \ | = reverse’ file.yaml` |
| `yq ‘.tags \ | unique’ file.yaml` |
| `yq ‘.items \ | flatten’ file.yaml` |
| `yq ‘.items \ | group_by(.kind)’ file.yaml` |
| `yq ‘.items \ | map(.name)’ file.yaml` |
| `yq ‘.items \ | map(select(.active))’ file.yaml` |
yq '.items = .items + .newItems' file.yaml | قم بدمج المصفوفات |
| `yq ‘.items \ | = unique_by(.name)’ file.yaml` |
yq '[.items[].name]' file.yaml | اجمع القيم في مصفوفة جديدة |
| أمر | وصف |
|---|
yq ea 'select(fi == 0) * select(fi == 1)' f1.yaml f2.yaml | دمج عميق لملفين (f2 يتجاوز f1) |
yq ea '. as $item ireduce ({}; . * $item)' *.yaml | دمج ملفات متعددة |
yq ea 'select(fi == 0) *+ select(fi == 1)' f1.yaml f2.yaml | دمج مع اتصال المصفوفات |
yq ea '[.]' file1.yaml file2.yaml | دمج الملفات في مصفوفة |
yq '.config = load("config.yaml")' file.yaml | تحميل ودمج الملف الخارجي |
yq '.spec.template = load("template.yaml").spec' file.yaml | تحميل مسار محدد من الملف |
yq ea 'select(fi == 0) *d select(fi == 1)' f1.yaml f2.yaml | الدمج العميق مع الحذف |
| أمر | وصف |
|---|
yq '.fullName = .firstName + " " + .lastName' file.yaml | دمج السلاسل |
| `yq ‘.name \ | = upcase’ file.yaml` |
| `yq ‘.name \ | = downcase’ file.yaml` |
| `yq ‘.name \ | = trim’ file.yaml` |
| `yq ‘.text \ | = sub(“old”, “new”)’ file.yaml` |
| `yq ‘.text \ | = gsub(“old”, “new”)’ file.yaml` |
| `yq ‘.path \ | split(”/”)’ file.yaml` |
| `yq ‘.tags \ | join(”, ”)’ file.yaml` |
| `yq ‘.name \ | length’ file.yaml` |
| `yq ‘.text \ | contains(“substring”)’ file.yaml` |
| أمر | وصف |
|---|
yq -o=json '.' file.yaml | تحويل YAML إلى JSON |
yq -P '.' file.json | حول JSON إلى YAML |
yq -o=xml '.' file.yaml | تحويل YAML إلى XML |
yq -p=xml '.' file.xml | تحويل XML إلى YAML |
yq -o=csv '.items[]' file.yaml | تحويل YAML إلى CSV |
yq -o=props '.' file.yaml | تحويل YAML إلى صيغة properties |
yq -o=json -I=4 '.' file.yaml | JSON مع المسافة البادئة المخصصة |
yq -o=yaml --yaml-output-version=1.1 '.' file.yaml | حدد إصدار YAML |
yq -p=csv -o=json '.' file.csv | تحويل CSV إلى JSON عبر YAML |
# Input/Output format options
-p, --input-format string Input format (yaml/json/xml/csv/props)
-o, --output-format string Output format (yaml/json/xml/csv/props)
-P, --prettyPrint Pretty print (shorthand for -o=yaml)
# Modification options
-i, --inplace Edit file in place
-I, --indent int Indentation (default 2)
# Processing options
-e, --exit-status Exit with status code based on result
-n, --null-input Don't read input, start with null
-N, --no-colors Disable colored output
-C, --colors Force colored output
# Multiple file options
ea, eval-all Evaluate all files together
```### خيارات سطر الأوامر
```yaml
# Basic path expressions
.field # Access field
.nested.field # Nested access
.[0] # Array index
.[] # Array iteration
.* # All fields
# Operators
= # Assignment
|= # Update assignment
+= # Append/increment
* # Multiply/merge
+ # Add/concatenate
- # Subtract
// # Alternative operator (default value)
# Functions
select() # Filter
map() # Transform array
has() # Check existence
keys # Get keys
length # Get length
sort_by() # Sort array
group_by() # Group array
unique # Remove duplicates
```### بناء التعبيرات
```bash
# Use environment variables in expressions
export APP_NAME="my-app"
yq '.name = env(APP_NAME)' file.yaml
# With default value
yq '.name = (env(NAME) // "default")' file.yaml
# String interpolation
yq '.message = "Hello " + env(USER)' file.yaml
```### متغيرات البيئة
```bash
# Single deployment
yq -i '.spec.replicas = 5' deployment.yaml
# Multiple deployments in one file
yq -i '(.spec.replicas | select(. != null)) = 5' deployments.yaml
# Conditionally update specific deployment
yq -i '(select(.metadata.name == "api-server") | .spec.replicas) = 10' deployment.yaml
# Update all deployments in multiple files
yq -i '.spec.replicas = 3' k8s/*.yaml
```### الحالة الاستخدامية 1: تحديث نسخ Kubernetes Deployment
```bash
# Merge base config with environment-specific overrides
yq ea 'select(fi == 0) * select(fi == 1)' base-config.yaml prod-config.yaml > final-config.yaml
# Merge multiple environment files
yq ea '. as $item ireduce ({}; . * $item)' base.yaml dev.yaml local.yaml > merged.yaml
# Merge with array concatenation
yq ea 'select(fi == 0) *+ select(fi == 1)' config1.yaml config2.yaml > combined.yaml
```### الحالة الاستخدامية 2: دمج ملفات التكوين
```bash
# Extract all container images from Kubernetes manifests
yq '.spec.template.spec.containers[].image' deployment.yaml
# Get all service names and ports
yq '.items[] | select(.kind == "Service") | .metadata.name + ":" + (.spec.ports[0].port | tostring)' services.yaml
# Create summary report
yq '.items[] | {"name": .metadata.name, "kind": .kind, "namespace": .metadata.namespace}' resources.yaml -o=json
```### الحالة الاستخدامية 3: استخراج وتحويل البيانات
```bash
# Add label to all resources
find . -name "*.yaml" -exec yq -i '.metadata.labels.environment = "production"' {} \;
# Update image tag in all deployments
yq -i '(.spec.template.spec.containers[].image | select(. == "*:latest")) |= sub(":latest", ":v1.2.3")' k8s/**/*.yaml
# Add annotation to specific resources
yq -i 'select(.kind == "Service") | .metadata.annotations."prometheus.io/scrape" = "true"' *.yaml
```### الحالة الاستخدامية 4: تحديثات جماعية عبر عدة ملفات
```bash
# Update version in multiple config files
export VERSION="2.1.0"
yq -i '.version = env(VERSION)' chart/Chart.yaml
yq -i '.image.tag = env(VERSION)' values.yaml
# Inject secrets from environment
yq -i '.database.password = env(DB_PASSWORD)' config.yaml
# Generate environment-specific configs
for env in dev staging prod; do
yq ea 'select(fi == 0) * select(fi == 1)' base.yaml "env-${env}.yaml" > "config-${env}.yaml"
done
```### الحالة الاستخدامية 5: تكوين أنبوب CI/CD
`-i`- **دائمًا اختبر بدون**
```bash
yq '.spec.replicas = 5' deployment.yaml # Preview first
yq -i '.spec.replicas = 5' deployment.yaml # Then apply
```**استخدم التحكم بالإصدارات**: التزم الملفات قبل التعديلات الجماعية للتمكن من التراجع بسهولة إذا لزم الأمر```bash
yq '.items[] | select(.name == "test")' file.yaml # Correct
- تحقق من صحة YAML بعد التعديلات: تأكد من أن تغييراتك تنتج YAML صالحًا
yq '.' modified.yaml > /dev/null && echo "Valid YAML" || echo "Invalid YAML"
- استخدم [محتوى مفقود] للتحديثات الشرطية: أكثر دقة من تحديث كل شيء
select()
- احفظ التعليقات: يحافظ yq على التعليقات بشكل افتراضي، لكن كن حذرًا مع التحويلات المعقدة
yq '(select(.kind == "Deployment") | .spec.replicas) = 3' file.yaml
- استخدم [محتوى مفقود] للعمليات متعددة الملفات: أكثر كفاءة من معالجة الملفات بشكل منفصل
eval-all
- استفد من متغيرات البيئة: أبقِ البيانات الحساسة خارج البرامج النصية
yq ea '. as $item ireduce ({}; . * $item)' *.yaml
- استخدم الإخراج الخام للبرمجة: استخدم [علم مفقود] عند التوجيه إلى أوامر أخرى
export SECRET_KEY="..."
yq '.apiKey = env(SECRET_KEY)' config.yaml
- تحقق من أكواد الخروج للتحقق: استخدم [علم مفقود] للفشل عند النتائج الفارغة/الخاطئة
-r
استكشاف الأخطاء وإصلاحها
IMAGE=$(yq -r '.spec.template.spec.containers[0].image' deployment.yaml)
مرجع سريع - أنماط شائعة
Would you like me to clarify or complete the missing parts of the texts?-e flag to fail on null/false results
yq -e '.spec.replicas > 0' deployment.yaml && echo "Valid" || echo "Invalid"
Troubleshooting
| مشكلة | حل |
|---|
| Error: “bad file descriptor” | Use -i flag correctly or redirect output: yq '.' file.yaml > temp && mv temp file.yaml |
| Changes not persisted | Add -i flag for in-place editing: yq -i '.field = "value"' file.yaml |
| ”null” appears in output | Field doesn’t exist or is null. Use alternative operator: yq '.field // "default"' file.yaml |
| Comments are removed | Use ... comments="" to explicitly remove, or check if using operations that don’t preserve comments |
| Array merge replaces instead of concatenates | Use *+ instead of * for merge: yq ea 'select(fi==0) *+ select(fi==1)' f1.yaml f2.yaml |
| ”Error: bad expression” | تحقق من بناء التعبير، تأكد من الاقتباس الصحيح، تحقق من صحة العوامل |
| Output has extra quotes | Use -r flag for raw output: yq -r '.name' file.yaml |
| Cannot process multiple files | Use ea (eval-all) command: yq ea '.' file1.yaml file2.yaml |
| Wrong version of yq | Verify you have mikefarah/yq (not kislyuk/yq): yq --version should show github.com/mikefarah/yq |
Permission denied on -i | Ensure write permissions: chmod u+w file.yaml or run with appropriate privileges |
| Encoding issues with special characters | Ensure UTF-8 encoding: yq --encoding=utf-8 '.' file.yaml |
| Large files cause memory issues | Process in chunks or use streaming: yq -N '.items[]' large-file.yaml |
| Path not found errors | Verify path exists: yq 'has("path.to.field")' file.yaml before accessing |
| Merge conflicts with complex structures | Use explicit merge strategies: *d for deep merge with deletion, *+ for array concatenation |
Quick Reference - Common Patterns
# Read value
yq '.path.to.field' file.yaml
# Update value
yq -i '.path.to.field = "new-value"' file.yaml
# Delete field
yq -i 'del(.path.to.field)' file.yaml
# Filter array
yq '.items[] | select(.name == "target")' file.yaml
# Merge files
yq ea 'select(fi==0) * select(fi==1)' base.yaml override.yaml
# Convert format
yq -o=json '.' file.yaml
# Use environment variable
yq '.field = env(VAR_NAME)' file.yaml
# Multiple operations
yq -i '.field1 = "value1" | .field2 = "value2"' file.yaml