آرگومان‌های مکانی (positional arguments)

jq_filter

فیلتر پردازشگر jq برای اعمال بر روی داده‌ها.

files

فایل یا فایل‌های YAML ورودی (در صورت عدم تعیین، از ورودی استاندارد خوانده می‌شود).

گزینه‌ها (options)

-h, --help

نمایش این پیام راهنما و خروج.

--yaml-output, --yml-output, -y

تبدیل خروجی JSON فیلتر jq به فرمت YAML و انتشار آن در خروجی.

--yaml-roundtrip, --yml-roundtrip, -Y

تبدیل خروجی JSON فیلتر jq به فرمت YAML و انتشار آن. حفظ تگ‌ها و سبک‌های نگارش YAML با بازنمایی آن‌ها به صورت آیتم‌های اضافی در نگاشت‌ها و توالی‌های دربرگیرنده هنگام تبدیل به JSON. این گزینه با فیلترهای jq که انتظار این آیتم‌های اضافی را ندارند، ناسازگار است.

--yaml-output-grammar-version, --yml-out-ver {1.1,1.2}

هنگام استفاده از گزینه --yaml-output، نسخه گرامر خروجی را مشخص می‌کند (مقدار پیش‌فرض 1.1 است و در نسخه‌های آینده به 1.2 تغییر خواهد کرد). تنظیم این مقدار روی 1.2 باعث می‌شود رشته‌هایی مانند 'on' و 'no' بدون علامت نقل‌قول چاپ شوند.

--width, -w WIDTH

هنگام استفاده از گزینه --yaml-output، عرض شکستن خطوط رشته‌ها (wrap width) را مشخص می‌کند.

--indentless-lists, --indentless

هنگام استفاده از گزینه --yaml-output، تورفتگی لیست‌های قالبی (sequences) را به جای ۲ فاصله، با ۰ فاصله اعمال می‌کند.

--explicit-start

هنگام استفاده از گزینه --yaml-output، همیشه نشانگر صریح شروع سند ("---") را در خروجی چاپ می‌کند.

--explicit-end

هنگام استفاده از گزینه --yaml-output، همیشه نشانگر صریح پایان سند ("...") را در خروجی چاپ می‌کند.

--in-place, -i

ویرایش فایل‌ها در جا (بدون نسخه پشتیبان - با احتیاط استفاده شود).

--version

نمایش شماره نسخه برنامه و خروج.

jq - پردازشگر خط فرمان JSON [نسخه 1.7]

jq [گزینه‌ها] --args <فیلتر jq> [رشته‌ها...]
jq [گزینه‌ها] --jsonargs <فیلتر jq> [متن‌های JSON...]

ابزار jq برنامه‌ای برای پردازش ورودی‌های JSON است که فیلتر داده‌شده را بر ورودی‌های متنی JSON اعمال کرده و نتیجه را به صورت JSON در خروجی استاندارد تولید می‌کند.

ساده‌ترین فیلتر . است که ورودی jq را بدون دستکاری (به جز قالب‌بندی و فاصله‌گذاری) مستقیماً به خروجی منتقل می‌کند. برای مشاهده فیلترهای پیشرفته‌تر، به صفحه راهنمای jq(1) ("man jq") یا نشانی https://jqlang.github.io/jq مراجعه کنید.

مثال‌ها (EXAMPLES)

$ echo '{"foo": 0}' | jq .
{
  "foo": 0
}

گزینه‌های دستور (Command options)

-n, --null-input

استفاده از `null` به عنوان تنها مقدار ورودی؛

-R, --raw-input

خواندن هر خط به عنوان یک رشته به جای داده‌های JSON؛

-s, --slurp

خواندن تمام ورودی‌ها در یک آرایه و استفاده از آن آرایه به عنوان تنها مقدار ورودی؛

-c, --compact-output

تولید خروجی فشرده (compact) به جای خروجی قالب‌بندی‌شده و خوانا (pretty-printed)؛

-r, --raw-output

چاپ رشته‌ها در خروجی بدون نویسه‌های گریز (escapes) و علامت‌های نقل‌قول؛

--raw-output0

گزینه -r را فعال کرده و پس از هر خروجی، یک بایت خالی (NUL) درج می‌کند؛

-j, --join-output

گزینه -r را فعال کرده و خروجی را بدون درج خط جدید (newline) پس از هر مورد چاپ می‌کند؛

-a, --ascii-output

چاپ رشته‌ها تنها با نویسه‌های اسکی (ASCII) و با استفاده از توالی‌های گریز؛

-S, --sort-keys

مرتب‌سازی کلیدهای هر شیء در خروجی؛

-C, --color-output

رنگی کردن خروجی JSON؛

-M, --monochrome-output

غیرفعال کردن خروجی رنگی؛

--tab

استفاده از نویسه تب (Tab) برای تورفتگی؛

--indent n

استفاده از n فاصله برای تورفتگی (حداکثر ۷ فاصله)؛

--unbuffered

تخلیه آنی بافر جریان خروجی (flush) پس از چاپ هر خروجی؛

--stream

تجزیه و پارس کردن مقدار ورودی به صورت جریانی (streaming)؛

--stream-errors

گزینه --stream را فعال کرده و خطاهای تجزیه را به صورت یک آرایه گزارش می‌دهد؛

--seq

تجزیه ورودی/خروجی بر اساس قالب application/json-seq؛

-f, --from-file فایل

بارگذاری فیلتر از فایل مشخص‌شده؛

-L پوشه

جستجوی ماژول‌ها در دایرکتوری مشخص‌شده؛

--arg name value

تنظیم متغیر $name به مقدار رشته‌ای مشخص‌شده؛

--argjson name value

تنظیم متغیر $name به مقدار JSON مشخص‌شده؛

--slurpfile name file

تنظیم متغیر $name به آرایه‌ای از مقادیر JSON خوانده‌شده از فایل؛

--rawfile name file

تنظیم متغیر $name به محتوای رشته‌ای خوانده‌شده از فایل؛

--args

مصرف آرگومان‌های باقی‌مانده به عنوان مقادیر رشته‌ای مکانی؛

--jsonargs

مصرف آرگومان‌های باقی‌مانده به عنوان مقادیر JSON مکانی؛

-e, --exit-status

تنظیم کد وضعیت خروج بر اساس خروجی فیلتر؛

-V, --version

نمایش نسخه برنامه؛

--build-configuration

نمایش پیکربندی ساخت (build configuration) ابزار jq؛

-h, --help

نمایش راهنما؛

--

پایان دادن به پردازش آرگومان‌ها؛

آرگومان‌های نام‌دار همچنین از طریق $ARGS.named[] و آرگومان‌های مکانی از طریق $ARGS.positional[] در دسترس هستند.