בדיקת הפקודות והאפשרויות ב-CLI

בדף הזה מופיע סיכום של פקודות ה-CLI והאפשרויות לכל פקודה. כדי לקבל מידע נוסף על כל פקודה של Checks CLI, משתמשים באפשרות --help, לדוגמה, checks login --help או checks reports --help.

שימוש

checks GROUP | COMMAND ARGUMENT \
    [OPTIONAL=FLAG_ARGUMENT] \
    {OPTIONAL_A | OPTIONAL_B}
    [CHECKS_WIDE_FLAG …]

הפקודות הזמינות ב-CLI

תצורה

‫Command	תיאור
login	מאמתים את ה-CLI בחשבון Google. נדרשת גישה לדפדפן אינטרנט.
עדכון	הפקודה מחזירה את הגרסה האחרונה שזמינה של Checks CLI.
עזרה	מציגה מידע עזרה לגבי ה-CLI או פקודות ספציפיות.
גרסה	הפקודה מדפיסה את פרטי הגרסה של רכיבי Checks CLI וכוללת הודעה אם יש עדכונים זמינים.

דוחות

‫Command	תיאור
report generate	יצירת דוח באופן אסינכרוני בחשבון ובאפליקציה שצוינו באמצעות קובץ בינארי שסופק.
report get	שליפת נתונים מהדוח של האפליקציה שצוינה.
המתנה לפעולות דיווח	דגימה של פעולת דוח ממושכת עד להשלמתה. בסיום הפעולה, הפקודה הזו תציג את תוצאות הדוח.
report operations list	רשימה של כל פעולות הדוחות בחשבון שצוין.

קוד

‫Command	תיאור
סריקת קוד	סריקה של קוד המקור באמצעות Checks Code Compliance בנתיב שצוין.

דיווחים נפוצים

Flag	תיאור
account-id	המונח הזה מתייחס לחשבון ספציפי ב-Checks.
עזרה	מציג את מסמכי העזרה של פקודה מסוימת, כולל הדגלים והארגומנטים הנתמכים.
גרסה	מדפיס את פרטי הגרסה של ה-CLI ויוצא. הדגל הזה זמין רק בכל העולם.
no-input	כך המשתמשים יכולים להשבית את כל ההנחיות בפקודות באופן מפורש. אם הפקודה דורשת קלט, הפקודה תיכשל ותסביר למשתמש איך להעביר את המידע כדגל.
json	כברירת מחדל, התשובות מודפסות בפלט הסטנדרטי בפורמט קריא. אפשר להשתמש בדגל json כדי לשנות את פורמט הפלט שמוגדר כברירת מחדל לפורמט JSON.
wait-and-print-report	דגל נוחות לפקודה report generate שחוסם את החזרת הפקודה עד לסיום יצירת הדוח.