FY-TOOL(1)

libfyaml

FY-TOOL(1)

نام (NAME)

fy-tool - ابزار تجزیه، اعتبارسنجی و دستکاری فایل‌های YAML

خلاصه دستور (SYNOPSIS)

fy-tool [گزینه‌ها] [<فایل> …]

fy-dump [گزینه‌ها] [<فایل> …]

fy-testsuite [گزینه‌ها] <فایل>

fy-filter [گزینه‌ها] [-f FILE] [<مسیر> …]

fy-join [گزینه‌ها] [-T PATH] [-F PATH] [-t PATH] [<فایل> …]

fy-ypath [گزینه‌ها] <ypath-expression> [<فایل> …]

fy-compose [گزینه‌ها] [<فایل> …]

fy-b3sum [گزینه‌ها] [<فایل> …]

توضیحات (DESCRIPTION)

دستور fy-tool رابط خط فرمان کتابخانه libfyaml برای تجزیه، بازنویسی، پرس‌وجو، ادغام، آزمایش و محاسبه هش داده‌های YAML و JSON است.

رفتار این فایل اجرایی بر اساس نام برنامه فراخوانی‌شده (fy-dump، fy-testsuite، fy-filter، fy-join، fy-ypath، fy-compose، fy-b3sum) یا با گزینه‌های صریح انتخاب حالت مانند --dump یا --filter تغییر می‌کند.

حالت پیش‌فرض dump است.

گزینه‌ها (OPTIONS)

گزینه‌های عمومی

-h, --help: نمایش پیام راهنمای توکار.

-v, --version: نمایش نسخه libfyaml.

-q, --quiet: جلوگیری از نمایش خروجی‌های اطلاعاتی و هشدارهای غیربحرانی.

-d LEVEL, --debug-level LEVEL: تعیین حداقل سطح شدت پیام‌های تشخیصی صادرشده توسط کتابخانه. مقدار پیش‌فرض 3 (سطح هشدار) است.

-C MODE, --color MODE: کنترل خروجی رنگی ANSI. مقادیر پشتیبانی‌شده عبارتند از on، off و auto. مقدار پیش‌فرض auto است.

-V, --visible: نمایش فاصله‌ها، تب‌ها و شکست‌های خط در خروجی متنی.

--dry-run: تجزیه ورودی بدون تولید خروجی معمول.

گزینه‌های عیب‌یابی

--disable-diag MODULE: غیرفعال کردن خروجی تشخیصی برای ماژول مشخص‌شده.

--enable-diag MODULE: فعال کردن خروجی تشخیصی برای ماژول مشخص‌شده.

--show-diag OPTION: نمایش فیلد تشخیصی مشخص‌شده. مقادیر پشتیبانی‌شده عبارتند از source، position، type و module.

--hide-diag OPTION: پنهان کردن فیلد تشخیصی مشخص‌شده.

گزینه‌های تجزیه‌کننده

-I DIR, --include DIR: افزودن DIR به مسیر جستجوی شمول (include) ورودی.

-j MODE, --json MODE: انتخاب نحوه مدیریت ورودی JSON. مقادیر پشتیبانی‌شده عبارتند از no، force و auto. مقدار پیش‌فرض auto است.

-r, --resolve: حل لنگرها (anchors) و کلیدهای ادغام در حین تجزیه.

--yaml-1.1: اعمال اجباری قواعد YAML 1.1 هنگامی که ورودی نسخه را اعلام نکرده باشد.

--yaml-1.2: اعمال اجباری قواعد YAML 1.2 هنگامی که ورودی نسخه را اعلام نکرده باشد.

--yaml-1.3: اعمال اجباری قواعد YAML 1.3 هنگامی که ورودی نسخه را اعلام نکرده باشد.

-l, --follow: دنبال کردن نام‌های مستعار (aliases) در حین پیمایش مسیر و عملیات مبتنی بر مسیر مرتبط.

--sloppy-flow-indentation: پذیرش قوانین تورفتگی آسان‌گیرانه در حالت جریان (flow mode).

--prefer-recursive: ترجیح الگوریتم‌های بازگشتی بر الگوریتم‌های تکرارشونده (iterative).

--ypath-aliases: فعال‌سازی پردازش نام‌های مستعار برای ارزیابی ypath.

--allow-duplicate-keys: مجاز دانستن کلیدهای نگاشت تکراری.

--collect-errors: جمع‌آوری چندین خطای تجزیه پیش از گزارش شکست.

--disable-accel: غیرفعال کردن ویژگی‌های شتاب‌دهنده تجزیه‌کننده/تولیدکننده.

--disable-buffering: غیرفعال کردن بافرینگ stdio و استفاده از خواندن مستقیم توصیف‌گر فایل (file descriptor).

--disable-mmap: غیرفعال کردن ورودی مبتنی بر نگاشت حافظه (mmap).

--disable-depth-limit: غیرفعال کردن محدودیت معمول عمق تو در تویی.

گزینه‌های تولیدکننده خروجی

-i INDENT, --indent INDENT: تعیین عرض تورفتگی خروجی. مقدار پیش‌فرض 2 است.

-w WIDTH, --width WIDTH: تعیین عرض ترجیحی خروجی. برای عدم اعمال محدودیت عرض از inf استفاده کنید. مقدار پیش‌فرض 80 است.

-m MODE, --mode MODE: انتخاب شیوه خروجی. مقادیر پشتیبانی‌شده عبارتند از original، block، flow، flow-oneline، json، json-tp، json-oneline، dejson، pretty، flow-compact و json-compact.

-s, --sort: مرتب‌سازی کلیدهای نگاشت پیش از تولید خروجی.

-c, --comment: حفظ و صدور توضیحات (کامنت‌ها) در صورت پشتیبانی.

--strip-labels: حذف لنگرها و نام‌های مستعار از خروجی صادرشده.

--strip-tags: حذف برچسب‌های صادرشده.

--strip-doc: حذف نشانگرهای شروع و پایان سند.

--strip-empty-kv: نادیده گرفتن کلیدهایی که مقادیر آن‌ها خالی یا تهی (null) است.

--null-output: جلوگیری از تولید خروجی معمول.

--no-ending-newline: عدم افزودن خط جدید پایانی.

--preserve-flow-layout: حفظ چیدمان مجموعه‌های جریانی تک‌خطی در صورت امکان.

--indented-seq-in-map: ایجاد تورفتگی برای توالی‌های بلوکی که درون نگاشت‌های بلوکی قرار دارند.

--streaming: استفاده از حالت خروجی جریانی. این حالت پیش‌فرض است.

--no-streaming: غیرفعال کردن حالت خروجی جریانی.

--recreating: بازتولید رویدادهای جریانی به جای عبور مستقیم آن‌ها.

گزینه‌های مجموعه آزمون

--disable-flow-markers: نادیده گرفتن نشانگرهای جریان در مجموعه آزمون.

--disable-doc-markers: نادیده گرفتن نشانگرهای سند در مجموعه آزمون.

--disable-scalar-styles: نادیده گرفتن نشانگرهای سبک اسکالر در مجموعه آزمون.

--document-event-stream: ساخت ابتدا سند و سپس تولید جریان رویدادها از روی آن.

--tsv-format: صدور خروجی مجموعه آزمون در قالب TSV.

گزینه‌های ورودی

-f FILE, --file FILE: خواندن از FILE به جای ورودی استاندارد در حالت‌هایی که از یک منبع ورودی استفاده می‌کنند. اگر FILE با > آغاز شود، ادامه متن به عنوان محتوای ورودی لفظی در نظر گرفته می‌شود.

گزینه‌های ادغام

-T PATH, --to PATH: ادغام در PATH. مقدار پیش‌فرض / است.

-F PATH, --from PATH: دریافت ورودی ادغام‌شده از PATH. مقدار پیش‌فرض / است.

-t PATH, --trim PATH: صدور تنها PATH از نتیجه ادغام‌شده. مقدار پیش‌فرض / است.

گزینه‌های YPATH

-F PATH, --from PATH: شروع ارزیابی از PATH. مقدار پیش‌فرض / است.

--dump-pathexpr: نمایش عبارت مسیر تجزیه‌شده پیش از ارزیابی.

--noexec: تجزیه عبارت بدون اجرای آن.

گزینه‌های ترکیب (Compose)

--dump-path: نمایش مسیر در حین ترکیب سند.

گزینه‌های B3SUM

--b3sum: فعال‌سازی حالت محاسبه هش BLAKE3.

--derive-key CONTEXT: استفاده از حالت اشتقاق کلید همراه با CONTEXT.

--no-names: حذف نام فایل‌ها از خروجی چکسام.

--raw: صدور بایت‌های خام خلاصه پیام (digest).

--length N: صدور تنها N بایت خروجی، تا سقف حداکثر BLAKE3.

--check: بررسی و اعتبارسنجی چکسام‌های خوانده‌شده از فایل‌های ورودی.

--keyed: استفاده از هش کلیددار، با خواندن کلید مخفی از ورودی استاندارد.

--backend BACKEND: انتخاب پیاده‌سازی بک‌اند BLAKE3.

--list-backends: فهرست کردن بک‌اندهای موجود برای BLAKE3.

--num-threads N: تعیین تعداد ریسمان‌های پردازشی کارگر. مقدار 0 به معنی انتخاب خودکار و -1 غیرفعال‌کننده هش چندریسمانی است.

--file-buffer N: تعیین اندازه بافر ورودی/خروجی به ازای هر فایل.

--mmap-min-chunk N: تعیین حداقل اندازه تکه مورد استفاده برای ورودی هش با نگاشت حافظه.

--mmap-max-chunk N: تعیین حداکثر اندازه تکه مورد استفاده برای ورودی هش با نگاشت حافظه.

حالت‌ها

--dump: انتخاب حالت dump. این حالت پیش‌فرض و همچنین حالت مورد استفاده توسط fy-dump است.

--testsuite: انتخاب حالت مجموعه آزمون. این حالت همچنین توسط fy-testsuite استفاده می‌شود.

--filter: انتخاب حالت فیلتر. این حالت همچنین توسط fy-filter استفاده می‌شود.

--join: انتخاب حالت ادغام. این حالت همچنین توسط fy-join استفاده می‌شود.

--ypath: انتخاب حالت پرس‌وجوی ypath. این حالت همچنین توسط fy-ypath استفاده می‌شود.

--scan-dump: انتخاب حالت داخلی scan-dump.

--parse-dump: انتخاب حالت داخلی parse-dump.

--compose: انتخاب حالت dump هدایت‌کننده ترکیب‌کننده (composer-driver). این حالت همچنین توسط fy-compose استفاده می‌شود.

--yaml-version-dump: چاپ اطلاعات نسخه YAML.

مثال‌ها (EXAMPLES)

خروجی گرفتن مجدد از یک فایل YAML با استفاده از حالت پیش‌فرض تولیدکننده خروجی:

$ fy-dump invoice.yaml

حل لنگرها و حذف برچسب‌ها از نتیجه نهایی:

$ fy-dump -r --strip-labels simple-anchors.yaml

خواندن متن ورودی لفظی از طریق --file:

$ fy-filter --file \">foo: bar\" /

انتخاب داده‌ها از یک فایل با استفاده از عبارت مسیر:

$ fy-filter --file simple-anchors.yaml /baz/bar

ادغام دو نگاشت ریشه در یک سند واحد:

$ fy-join simple-anchors.yaml invoice.yaml

تولید خروجی رویدادهای مجموعه آزمون:

$ fy-testsuite invoice.yaml

فهرست کردن بک‌اندهای موجود برای BLAKE3:

$ fy-b3sum --list-backends

نویسندگان (AUTHORS)

Pantelis Antoniou <pantelis.antoniou@konsulko.com>

اشکالات (BUGS)

تنها کدگذاری نویسه‌ای پشتیبانی‌شده برای ورودی و خروجی UTF8 است.
مرتب‌سازی تنظیمات زبان و محلی را در نظر نمی‌گیرد.
هیچ راهکاری برای تعیین طرح رنگ‌بندی متفاوت توسط کاربر وجود ندارد.

همچنین ببینید (SEE ALSO)

libfyaml(3)

حق نشر (COPYRIGHT)

2019-2026, Pantelis Antoniou

March 15, 2026