با Checks CLI شروع کنید

رابط خط فرمان Checks، قابلیت Checks را به گردش کار توسعه شما می‌آورد. می‌توانید CLI را به صورت محلی، در خط لوله CI/CD یا از طریق انواع دیگر اسکریپت‌ها و اتوماسیون اجرا کنید.

راه‌اندازی و استفاده از Checks CLI مستلزم مراحل زیر است:

  1. نصب رابط خط فرمان (CLI) چک‌ها
  2. دستگاه خود را احراز هویت کنید
  3. با اجرای دستورات از خط فرمان یا ادغام Checks CLI در محیط CI/CD خود، Checks CLI را ادغام و استفاده کنید.

رابط خط فرمان (CLI) چک‌ها را راه‌اندازی کنید

شما می‌توانید رابط خط فرمان Checks را با استفاده از فایل‌های اجرایی مستقل در جداول لینوکس یا macOS نصب یا به‌روزرسانی کنید.

پس از نصب رابط خط فرمان Checks، باید احراز هویت شوید. سپس می‌توانید شروع به آزمایش و رفع آسیب‌پذیری‌های خود کنید، که این کار با آزمایش نصب آغاز می‌شود.

نصب با فایل‌های اجرایی مستقل

چکز لینک‌های دانلود مستقل و قابل اجرا را برای آخرین نسخه و برای نسخه‌های خاص ارائه می‌دهد. به عنوان مثال، لینک‌های زیر برای macOS و Linux هستند:

برای مثال، برای دانلود و اجرای آخرین نسخه Checks CLI در macOS، دستور زیر را اجرا کنید:

curl --compressed https://dl.google.com/checks/cli/latest/checks-macos -o checks
chmod +x ./checks
mv ./checks /usr/local/bin/
  1. مطمئن شوید که مدیر بسته و هرگونه ابزار شخص ثالث مورد نیاز را نصب کرده‌اید.
  2. فایل باینری Checks CLI را برای پلتفرم خود دانلود کنید:

لینوکس

پلتفرم

بسته

اندازه

بررسی SHA256

لینوکس

چک-لینوکس

۳۵.۱ مگابایت

cc12317c0d5b0a2edfe8d5bf28a3a0739d5bd469ccd771772bf65129ae97c94f

با اجرای دستور chmod +x ./checks فایل باینری را قابل اجرا کنید. ( اختیاری ) فایل باینری را به مکانی منتقل کنید که بتوانید آن را به صورت سراسری اجرا کنید: mv ./checks /usr/local/bin/

مک‌او‌اس

پلتفرم

بسته

اندازه

بررسی SHA256

مک‌او‌اس

چک-ماکوس

۲۹.۴ مگابایت

a82699336aaf0f6b0a9502c293c84be45459d79d348a74eae3bbaaf89d1daa33

با اجرای دستور chmod +x ./checks ( اختیاری )، فایل باینری را قابل اجرا کنید. فایل باینری را به مکانی منتقل کنید که بتوانید آن را به صورت سراسری اجرا کنید: mv ./checks /usr/local/bin/

ویندوز

پلتفرم

بسته

اندازه

بررسی SHA256

ویندوز ۸.۱ و بالاتر و ویندوز سرور ۲۰۱۲ و بالاتر

checks-win.exe

۲۹.۵ مگابایت

7ca465e28ffec9a7e16bc71e01bbaf9629c95d517e5846a31280a49af400d3c7

( اختیاری ) نام فایل را به checks.exe تغییر دهید تا بتوانید دستورات checks را طبق مستندات اجرا کنید، مثلاً checks help .

به آخرین نسخه CLI به‌روزرسانی کنید

برای اطمینان از دریافت جدیدترین ویژگی‌ها و رفع اشکالات، توصیه می‌کنیم مرتباً به‌روزرسانی‌های CLI را بررسی کنید.

می‌توانید نسخه جدید را از جداول قبلی دانلود کنید و سپس نسخه قبلی را در سیستم خود جایگزین کنید.

نصب خود را آزمایش کنید

پس از احراز هویت، می‌توانید نصب خود را آزمایش کنید. برای یک آزمایش سریع، checks --help اجرا کنید.

اطلاعات تکمیلی

checks --help را اجرا کنید یا خلاصه دستورات و گزینه‌های رابط خط فرمان (CLI) را مشاهده کنید.

دریافت پشتیبانی

هر زمان که در مورد رابط خط فرمان Checks یا Checks به طور کلی به کمک نیاز داشتید، به آدرس checks-support@google.com ایمیل ارسال کنید.

احراز هویت رابط خط فرمان (CLI)

پس از نصب رابط خط فرمان (CLI)، باید وارد یک حساب گوگل شوید. برای مجاز کردن دسترسی رابط خط فرمان چکز به چکز، از یک حساب کاربری یا یک حساب سرویس استفاده کنید.

یک حساب کاربری سرویس، یک حساب کاربری گوگل کلود مرتبط با پروژه گوگل کلود شماست و یک کاربر خاص نیست. حساب‌های کاربری سرویس برای تنظیم چک‌ها در یک محیط CI مفید هستند.

یک حساب کاربری، یک حساب گوگل است که به حساب Checks شما دسترسی دارد. این بهترین گزینه برای استفاده از رابط خط فرمان Checks از طریق خط فرمان است.

با یک حساب کاربری سرویس، احراز هویت کنید

  1. کنسول گوگل کلود را باز کنید و پروژه خود را انتخاب کنید.
  2. در کتابخانه API، API مربوط به Checks را فعال کنید.
  3. با رفتن به صفحه حساب‌های سرویس IAM در کنسول Google Cloud، یک حساب سرویس برای پروژه خود ایجاد کنید. روی ایجاد حساب سرویس کلیک کنید و جزئیات حساب سرویس را وارد کنید.
    1. یک کلید خصوصی JSON برای حساب سرویس تازه ایجاد شده خود ایجاد کنید و کلید را به مکانی که برای محیط ساخت شما قابل دسترسی است منتقل کنید. حتماً این فایل را در جایی امن نگه دارید ، زیرا به مدیر سیستم دسترسی به Checks را می‌دهد.
    2. هنگام استفاده از رابط خط فرمان (CLI)، متغیر محیطی CHECKS_CREDENTIALS روی مسیر فایل JSON کلید خصوصی خود تنظیم کنید. در صورت استفاده از افزونه Checks CI/CD، برای نحوه ارائه اعتبارنامه‌ها به مستندات افزونه مراجعه کنید.
  4. برای اعطای دسترسی به حساب کاربری سرویس به حساب کاربری Checks خود، آدرس ایمیل را اضافه کنید و در صفحه تنظیمات کنسول Checks، نقش مالک را به آن بدهید. برای اطلاعات بیشتر در مورد دعوت از کاربران به حساب کاربری Checks خود، به مدیریت دسترسی تیم مراجعه کنید.

احراز هویت با حساب کاربری

مهم: اگر از طریق SSH متصل می‌شوید، پورت ۹۰۰۵ را فوروارد کنید.

  1. با استفاده از حساب گوگل خود و با دستور زیر وارد رابط خط فرمان Checks شوید: checks login

    این دستور دستگاه محلی شما را به Checks متصل می‌کند و به شما امکان دسترسی به حساب‌های Checks را می‌دهد.

    • اگر قبلاً وارد سیستم شده‌اید، اما می‌خواهید به یک حساب گوگل دیگر بروید، از checks login --reauth استفاده کنید.
    • برای خروج از سیستم، checks logout استفاده کنید.
  2. URL احراز هویت تولید شده را در مرورگر باز کنید.

  3. وارد حساب گوگل خود شوید.

  4. به Checks اجازه دهید تا به حساب Checks شما دسترسی پیدا کند.