نام (NAME)

gh-repo-read-file - خواندن یک فایل از مخزن (پیش‌نمایش)

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

gh repo read-file <path> [flags]

توضیحات (DESCRIPTION)

خواندن محتویات یک فایل در یک مخزن گیت‌هاب بدون کلون کردن آن.

این دستور در مرحله پیش‌نمایش قرار دارد و ممکن است بدون اطلاع قبلی تغییر کند.

به‌طور پیش‌فرض، فایل از شاخه پیش‌فرض خوانده می‌شود. از گزینه --ref برای خواندن از یک شاخه، برچسب (tag) یا کامیت مشخص استفاده کنید.

هنگام اجرا در حالت TTY (ترمینال)، محتوا از طریق صفحه‌بندی‌کننده (pager) شما نمایش داده می‌شود. هنگامی که stdout پایپ یا هدایت مجدد شود، محتوای خام مستقیماً نوشته می‌شود. برای ذخیره فایل روی دیسک به جای آن، از گزینه --output استفاده کنید.

به‌طور پیش‌فرض، این دستور از خروجی دادن فایلی که حاوی توالی‌های فرار ترمینال (escape sequences) است خودداری می‌کند، زیرا ممکن است ترمینال شما را دستکاری کنند. برای خواندن فایل در هر صورت، گزینه --allow-escape-sequences را ارسال کنید. این بررسی تنها برای خروجی ترمینال و پایپ‌شده اعمال می‌شود؛ نوشتن روی دیسک با --output همیشه شامل بایت‌های خام است، درست مانند اینکه --allow-escape-sequences ارائه شده باشد.

گزینه‌ها (OPTIONS)

--allow-escape-sequences: مجاز کردن چاپ توالی‌های فرار ترمینال
--clobber: بازنویسی مسیر خروجی در صورتی که از قبل وجود داشته باشد
-q, --jq <expression>: فیلتر کردن خروجی JSON با استفاده از یک عبارت jq
--json <fields>: تولید خروجی JSON با فیلدهای مشخص‌شده
-o, --output <path>: نوشتن فایل در یک مسیر به جای خروجی استاندارد (stdout)
--ref <string>: شاخه، برچسب یا کامیتی که باید از آن خوانده شود
-R, --repo <[HOST/]OWNER/REPO>: انتخاب یک مخزن دیگر با استفاده از قالب [HOST/]OWNER/REPO
-t, --template <string>: قالب‌بندی خروجی JSON با استفاده از یک الگوی Go؛ دستور "gh help formatting" را ببینید

فیلدهای JSON (JSON FIELDS)

content, downloadUrl, encoding, gitSHA, gitUrl, htmlUrl, name, path, size, type, url

کدهای خروج (EXIT CODES)

0: اجرای موفقیت‌آمیز

1: خطا

2: دستور لغو شد

4: نیاز به احراز هویت است

نکته: دستورات خاص ممکن است کدهای خروج دیگری نیز داشته باشند. برای اطلاعات بیشتر به راهنمای همان دستور مراجعه کنید.

مثال (EXAMPLE)

# خواندن یک فایل از شاخه پیش‌فرض
$ gh repo read-file README.md --repo cli/cli
# خواندن یک فایل در یک ref مشخص
$ gh repo read-file README.md --repo cli/cli --ref v2.50.0
# ذخیره یک فایل روی دیسک
$ gh repo read-file README.md --repo cli/cli --output download/README.md
# چاپ فیلدهای انتخاب‌شده به صورت JSON
$ gh repo read-file README.md --repo cli/cli --json name,path,size,type
# خواندن فایلی که حاوی توالی‌های فرار ترمینال است
$ gh repo read-file path/to/file --repo OWNER/REPO --allow-escape-sequences

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

gh-repo(1)