NAME
gdcloud topic command-conventions - Bantuan tambahan untuk gdcloud command-conventions.
DESKRIPSI
Desain perintah gdcloud CLI mengikuti serangkaian prinsip dan konvensi umum. Dokumen ini menjelaskannya secara mendetail.
Konvensi adalah sasaran, bukan aturan. Untuk pengecualian apa pun, lihat informasi yang diberikan untuk setiap perintah menggunakan flag --help.
HIERARKI PERINTAH
Perintah gdcloud CLI disusun sebagai pohon dengan gdcloud di root, grup perintah di node dalam, dan perintah di node leaf. Perintah grup dapat dieksekusi, tetapi hanya untuk menampilkan teks bantuan.
Semua grup dan perintah memiliki flag --help yang menampilkan teks bantuan sebagai output standar. Teks bantuan berasal dari executable yang berjalan, sehingga selalu terbaru, bahkan saat beralih di antara beberapa penginstalan rilis.
COMMAND LINE
Setiap perintah gdcloud mengikuti format yang sama
gdcloud GROUP GROUP ... COMMAND POSITIONAL ... FLAG ...
Argumen posisi dan flag dapat digabungkan, tetapi untuk konsistensi, posisi biasanya ditampilkan terlebih dahulu dalam urutan, diikuti oleh flag dalam urutan apa pun.
NOTASI PENGGUNAAN PERINTAH
Penggunaan perintah adalah notasi singkat yang berisi nama perintah lengkap, argumen posisi, dan argumen flag dalam urutan yang diurutkan grup. Argumen opsional diapit oleh [ ... ]. Contohnya
gdcloud foo bar NAME [--format=FORMAT]
Ini adalah penggunaan untuk perintah gdcloud foo bar dengan argumen posisi NAME yang diperlukan, argumen posisi EXTRA opsional, dan argumen flag --format opsional.
Argumen Posisi
Argumen posisi diurutkan dan harus ditentukan dalam urutan yang tercantum dalam daftar definisi argumen dokumen bantuan dan penggunaan perintah.
Argumen Flag
Nama flag menggunakan huruf kecil dengan awalan --. Flag multi-kata menggunakan - (tanda hubung/tanda pisah) sebagai pemisah kata.
Mengikuti konvensi UNIX, jika flag diulang di command line, hanya kemunculan paling kanan yang akan berlaku. Tidak ada diagnostik yang ditampilkan. Hal ini memudahkan penyiapan alias perintah dan skrip wrapper yang menyediakan nilai flag default; nilai yang dapat dengan mudah diganti dengan menentukannya di command line alias atau skrip wrapper.
Flag Boolean
Meskipun banyak flag boolean memiliki nilai tersirat false, beberapa flag secara default adalah true. Keberadaan --flag menetapkan flag ke true atau false, bergantung pada nilai yang tersirat oleh nama flag.
Flag Bernilai
Flag non-boolean memiliki nilai eksplisit. Nilai dapat ditentukan dengan menempatkan nilai sebagai argumen berikutnya setelah flag --flag value.
Jika nilainya adalah bilangan bulat, maka harus 0 atau di atasnya. Bilangan bulat negatif tidak diterima.
Output
Output standar adalah untuk informasi eksplisit yang diminta oleh perintah.
Bergantung pada konteksnya, mungkin ada jaminan pada format output untuk mendukung penguraian deterministik. Perintah tertentu menampilkan resource dan resource ini tercantum sebagai output standar yang biasanya menggunakan format tabel khusus perintah atau format YAML default. Selain itu, flag --format dapat digunakan untuk mengubah atau mengonfigurasi format output default ini. Nilai --format output yaml, json, dan csv menjamin bahwa penyelesaian perintah yang berhasil akan menghasilkan data output standar yang dapat diuraikan menggunakan format masing-masing. Penjelasan mendetail tentang kemampuan flag --format dapat ditemukan dengan perintah gdcloud topic formats. Untuk perintah yang tidak menampilkan resource, output ditentukan dalam flag --help perintah.
Error standar disediakan untuk diagnostik. Secara umum, format data error standar dapat berubah dari rilis ke rilis. Pengguna tidak boleh membuat skrip terhadap konten tertentu, atau bahkan keberadaan output ke error standar sama sekali. Satu-satunya indikator error yang andal adalah status keluar.
Tidak ada perintah gdcloud CLI yang boleh mengalami error dengan pengecualian yang tidak tertangkap. Namun, jika gdcloud CLI mengalami error, stack trace akan dicegat dan ditulis ke file log, dan diagnostik error akan ditulis ke error standar.
Status Keluar
Status keluar 0 menunjukkan keberhasilan. Status keluar lainnya menunjukkan error. Diagnostik khusus perintah akan menjelaskan sifat error dan cara memperbaikinya.