Mulai menggunakan Checks CLI

Checks CLI menghadirkan fungsi Checks ke dalam alur kerja pengembangan Anda. Anda dapat menjalankan CLI secara lokal, di pipeline CI/CD, atau melalui jenis skrip dan otomatisasi lainnya.

Penyiapan dan penggunaan Checks CLI memerlukan langkah-langkah berikut:

  1. Menginstal Checks CLI
  2. Mengautentikasi mesin Anda
  3. Mengintegrasikan dan menggunakan Checks CLI dengan menjalankan perintah dari command line atau mengintegrasikan Checks CLI ke dalam lingkungan CI/CD.

Menyiapkan Checks CLI

Anda dapat menginstal atau mengupdate Checks CLI menggunakan file yang dapat dieksekusi mandiri dalam tabel untuk Linux atau macOS.

Setelah menginstal Checks CLI, Anda harus melakukan autentikasi. Kemudian, Anda dapat mulai menguji dan memperbaiki kerentanan, dimulai dengan menguji penginstalan.

Menginstal dengan file yang dapat dieksekusi mandiri

Checks menyediakan link download file yang dapat dieksekusi mandiri untuk rilis terbaru dan untuk versi tertentu. Misalnya, link berikut adalah untuk macOS dan Linux:

Misalnya, untuk mendownload dan menjalankan Checks CLI terbaru di macOS, jalankan:

curl --compressed https://dl.google.com/checks/cli/latest/checks-macos -o checks
chmod +x ./checks
mv ./checks /usr/local/bin/
  1. Pastikan Anda telah menginstal pengelola paket dan alat pihak ketiga yang diperlukan.
  2. Download biner Checks CLI untuk platform Anda:

Linux

Platform

Paket

Ukuran

SHA256 Checksum

Linux

checks-linux

35,1 MB

cc12317c0d5b0a2edfe8d5bf28a3a0739d5bd469ccd771772bf65129ae97c94f

Jadikan biner sebagai file yang dapat dieksekusi dengan menjalankan chmod +x ./checks. (Opsional) Pindahkan biner ke lokasi tempat Anda dapat menjalankannya secara global: mv ./checks /usr/local/bin/

macOS

Platform

Paket

Ukuran

SHA256 Checksum

macOS

checks-macos

29,4 MB

a82699336aaf0f6b0a9502c293c84be45459d79d348a74eae3bbaaf89d1daa33

Jadikan biner sebagai file yang dapat dieksekusi dengan menjalankan chmod +x ./checks (Opsional) Pindahkan biner ke lokasi tempat Anda dapat menjalankannya secara global: mv ./checks /usr/local/bin/

Windows

Platform

Paket

Ukuran

SHA256 Checksum

Windows 8.1 dan yang lebih baru serta Windows Server 2012 dan yang lebih baru

checks-win.exe

29,5 MB

7ca465e28ffec9a7e16bc71e01bbaf9629c95d517e5846a31280a49af400d3c7

(Opsional) Ganti nama file menjadi checks.exe agar Anda dapat menjalankan perintah checks seperti yang didokumentasikan, misalnya, checks help.

Mengupdate ke versi CLI terbaru

Untuk memastikan Anda mendapatkan fitur dan perbaikan bug terbaru, sebaiknya Anda sering memeriksa update CLI.

Anda dapat mendownload versi baru dari tabel sebelumnya, lalu mengganti versi sebelumnya di sistem Anda.

Menguji penginstalan

Setelah melakukan autentikasi, Anda dapat menguji penginstalan. Untuk pengujian cepat, jalankan checks --help.

Informasi tambahan

Jalankan checks --help atau lihat ringkasan perintah dan opsi CLI.

Mendapatkan dukungan

Kirim email ke checks-support@google.com kapan pun Anda memerlukan bantuan terkait Checks CLI atau Checks secara umum.

Mengautentikasi CLI

Setelah menginstal CLI, Anda harus login ke Akun Google. Untuk mengotorisasi akses Checks CLI ke Checks, gunakan akun layanan atau akun pengguna.

Akun layanan adalah akun Google Cloud yang terkait dengan project Google Cloud Anda dan bukan pengguna tertentu. Akun layanan berguna untuk menyiapkan Checks di lingkungan CI.

Akun pengguna adalah Akun Google yang memiliki akses ke akun Checks Anda. Ini adalah opsi terbaik untuk menggunakan Checks CLI dari command line Anda.

Melakukan autentikasi dengan akun layanan

  1. Buka Google Cloud Console dan pilih project Anda.
  2. Di Library API, aktifkan Checks API.
  3. Buat akun layanan untuk project Anda dengan membuka halaman Akun Layanan IAM di Google Cloud Console. Klik Buat Akun Layanan dan masukkan detail akun layanan.
    1. Buat kunci JSON pribadi untuk akun layanan yang baru dibuat dan pindahkan kunci ke lokasi yang dapat diakses oleh lingkungan build Anda. Pastikan untuk menyimpan file ini di tempat yang aman, karena file ini memberikan akses administrator ke Checks.
    2. Tetapkan variabel lingkungan CHECKS_CREDENTIALS ke jalur file JSON kunci pribadi Anda saat menggunakan CLI. Jika menggunakan plugin Checks CI/CD, lihat dokumentasi plugin untuk mengetahui cara memberikan kredensial.
  4. Untuk memberikan akses Akun Layanan ke akun Checks Anda, tambahkan alamat email dan berikan peran Pemilik di halaman Setelan Konsol Checks. Untuk mengetahui informasi selengkapnya tentang cara mengundang pengguna ke akun Checks Anda, lihat Mengelola akses tim.

Melakukan autentikasi dengan akun pengguna

Penting: Jika Anda terhubung melalui SSH, teruskan port 9005.

  1. Login ke Checks CLI menggunakan Akun Google Anda dengan perintah berikut: checks login

    Perintah ini menghubungkan mesin lokal Anda ke Checks dan memberi Anda akses ke akun Checks Anda.

    • Gunakan checks login --reauth jika Anda sebelumnya telah login, tetapi ingin beralih ke Akun Google lain.
    • Gunakan checks logout untuk logout.

  2. Buka URL autentikasi yang dibuat di browser.

  3. Login ke Akun Google Anda.

  4. Berikan izin kepada Checks untuk mengakses akun Checks Anda.