نام (NAME)

gh-auth-login - ورود به یک حساب گیت‌هاب

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

gh auth login [flags]

توضیحات (DESCRIPTION)

احراز هویت با یک میزبان گیت‌هاب.

نام میزبان پیش‌فرض github.com است. این مقدار می‌تواند با استفاده از پرچم --hostname تغییر داده شود.

حالت احراز هویت پیش‌فرض، یک فرآیند مبتنی بر مرورگر وب است. پس از تکمیل، یک توکن احراز هویت به‌صورت امن در مخزن اعتبارسنجی سیستم ذخیره خواهد شد. در صورتی که مخزن اعتبارسنجی یافت نشود یا مشکلی در استفاده از آن رخ دهد، gh به‌عنوان راه‌حل جایگزین توکن را در یک فایل متنی ساده ذخیره خواهد کرد. برای مشاهده محل ذخیره‌سازی، gh auth status را ببینید.

همچنین می‌توانید از --with-token برای ارسال یک توکن دسترسی شخصی کلاسیک از طریق ورودی استاندارد استفاده کنید. حداقل دامنه‌های دسترسی (scopes) مورد نیاز برای توکن عبارتند از: repo، read:org و gist. هنگام ارسال توکن دسترسی شخصی دقیق (fine-grained) به --with-token احتیاط کنید؛ زیرا محدودیت ذاتی دامنه به منابع خاص ممکن است هنگام تعامل با سایر منابع رفتار غیرمنتظره‌ای ایجاد کند. برای استفاده از توکن دسترسی شخصی دقیق، تنظیم متغیر GH_TOKEN را در اولویت قرار دهید.

همچنین، gh می‌تواند از توکن احراز هویت موجود در متغیرهای محیطی استفاده کند. این روش برای استفاده بدون واسط گرافیکی (headless) از gh مانند خودکارسازی‌ها بسیار مناسب است. برای اطلاعات بیشتر، gh help environment را ببینید.

برای استفاده از gh در گیت‌هاب اکشنز (GitHub Actions)، مقدار GH_TOKEN: ${{ github.token }} را به env اضافه کنید.

پروتکل گیت مورد استفاده برای عملیات‌های گیت روی این میزبان را می‌توان با گزینه --git-protocol یا در حین اعلان‌های تعاملی مشخص کرد. اگرچه ورود به حساب تنها برای یک حساب کاربری روی یک میزبان است، اما تنظیم پروتکل گیت برای تمام کاربران آن میزبان اعمال خواهد شد.

مشخص کردن ssh برای پروتکل گیت، کلیدهای SSH موجود را برای بارگذاری شناسایی می‌کند و در صورت عدم وجود کلید، پیامی برای ساخت و بارگذاری کلید جدید نمایش می‌دهد. این مرحله را می‌توان با پرچم --skip-ssh-key نادیده گرفت.

برای اطلاعات بیشتر درباره دامنه‌های دسترسی OAuth، پیوند زیر را ببینید:

⟨https://docs.github.com/en/developers/apps/building-oauth-apps/scopes-for-oauth-apps⟩.

گزینه‌ها (OPTIONS)

-c, --clipboard: کپی کردن کد یک‌بارمصرف دستگاه OAuth در کلیپ‌بورد
-p, --git-protocol <string>: پروتکل مورد استفاده برای عملیات‌های گیت روی این میزبان: {ssh|https}
-h, --hostname <string>: نام میزبان نمونه گیت‌هاب برای احراز هویت با آن
--insecure-storage: ذخیره اطلاعات احراز هویت به‌صورت متن ساده به‌جای استفاده از مخزن اعتبارسنجی
-s, --scopes <strings>: دامنه‌های دسترسی احراز هویت اضافی برای درخواست
--skip-ssh-key: صرف‌نظر کردن از اعلان ساخت یا بارگذاری کلید SSH
-w, --web: باز کردن یک مرورگر برای احراز هویت
--with-token: خواندن توکن از ورودی استاندارد

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

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

1: خطا

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

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

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

مثال‌ها (EXAMPLES)

# شروع راه‌اندازی و ورود تعاملی
$ gh auth login
# باز کردن مرورگر برای احراز هویت و کپی کد یک‌بارمصرف OAuth در کلیپ‌بورد
$ gh auth login --web --clipboard
# احراز هویت در github.com با خواندن توکن از یک فایل
$ gh auth login --with-token < mytoken.txt
# احراز هویت با یک میزبان خاص
$ gh auth login --hostname enterprise.internal

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

gh-auth(1)