نام (NAME)

gh-extension-install - نصب یک افزونه gh از مخزن گیت‌هاب

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

gh extension install <repository> [flags]

توضیحات (DESCRIPTION)

نصب یک افزونه خط فرمان گیت‌هاب (GitHub CLI) از یک مخزن گیت‌هاب یا مخزن محلی.

برای مخازن گیت‌هاب، آرگومان مخزن را می‌توان در قالب OWNER/REPO یا به صورت یک نشانی اینترنتی (URL) کامل مخزن مشخص کرد. قالب URL زمانی مفید است که مخزن روی github.com میزبانی نشده باشد.

برای مخازن دوردست (remote)، ابزار GitHub CLI ابتدا با این فرض که با یک افزونه باینری سروکار دارد (یعنی باینری‌های از پیش ساخته‌شده که به عنوان بخشی از نسخه انتشار ارائه شده‌اند)، به دنبال آرتیفکت‌های انتشار (release artifacts) می‌گردد. در صورت عدم وجود نسخه انتشار، خود مخزن با این فرض که با یک افزونه اسکریپتی مواجه است (یعنی فایل اجرایی یا اسکریپت از پیش ساخته‌شده در ریشه آن وجود دارد)، کلون می‌شود.

از پرچم --pin می‌توان به ترتیب برای تعیین برچسب (tag) یا کامیت افزونه‌های باینری و اسکریپتی استفاده کرد؛ در غیر این صورت از آخرین نسخه استفاده می‌شود.

برای مخازن محلی، که اغلب هنگام توسعه افزونه‌ها استفاده می‌شوند، مقدار آرگومان مخزن را . قرار دهید. به نکات زیر توجه کنید:

پس از نصب یک افزونه از مخزن کلون‌شده محلی، ابزار GitHub CLI این افزونه را به عنوان یک پیوند نمادین (یا سازوکار معادل در ویندوز) مدیریت می‌کند که به یک فایل اجرایی با همان نام مخزن در ریشه مخزن اشاره دارد. برای مثال، اگر نام مخزن gh-foobar باشد، پیوند نمادین به gh-foobar در ریشه مخزن افزونه اشاره خواهد کرد.
هنگام اجرای افزونه، ابزار GitHub CLI فایل اجرایی یافت‌شده با دنبال کردن پیوند نمادین را اجرا می‌کند. اگر هیچ فایل اجرایی یافت نشود، اجرای افزونه با خطا مواجه خواهد شد.
اگر افزونه از پیش کامپایل شده باشد، فایل اجرایی باید به صورت دستی ساخته شده و در ریشه مخزن قرار گیرد.

برای مشاهده فهرست افزونه‌های موجود، ببینید: ⟨https://github.com/topics/gh-extension⟩.

گزینه‌ها (OPTIONS)

--force: ارتقای اجباری افزونه، یا نادیده گرفتن در صورتی که آخرین نسخه قبلاً نصب شده باشد
--pin <string>: ثابت کردن (pin) افزونه روی یک برچسب انتشار یا ارجاع کامیت

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

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

1: خطا

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

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

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

مثال‌ها (EXAMPLES)

# نصب افزونه از یک مخزن دوردست میزبانی‌شده در گیت‌هاب
$ gh extension install owner/gh-extension
# نصب افزونه از یک مخزن دوردست از طریق نشانی کامل URL
$ gh extension install https://my.ghes.com/owner/gh-extension
# نصب افزونه از یک مخزن محلی در دایرکتوری کاری فعلی
$ gh extension install .

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

gh-extension(1)