NAMA
gdcloud topic command-conventions - Supplementary help for 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, 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 daun. Perintah grup dapat dieksekusi, tetapi hanya untuk menampilkan teks bantuan.
Semua grup dan perintah memiliki tanda --help yang menampilkan teks bantuan sebagai output standar. Teks bantuan berasal dari file yang dapat dieksekusi yang sedang 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 tanda dan posisi dapat digabungkan, tetapi untuk konsistensi, posisi biasanya ditampilkan terlebih dahulu dalam urutan, diikuti dengan tanda dalam urutan apa pun.
NOTASI PENGGUNAAN PERINTAH
Penggunaan perintah adalah notasi singkat yang berisi nama perintah lengkap, argumen posisional, dan argumen flag dalam urutan yang dikelompokkan. Argumen opsional diapit oleh [ ... ]. Contohnya
gdcloud foo bar NAME [--format=FORMAT]
Berikut adalah penggunaan perintah gdcloud foo bar dengan argumen posisi NAME wajib, argumen posisi EXTRA opsional, dan argumen flag --format opsional.
Argumen Posisi
Argumen posisional diurutkan dan harus ditentukan dalam urutan yang tercantum dalam penggunaan perintah dan daftar definisi argumen dokumen bantuan.
Argumen Flag
Nama tanda huruf kecil dengan awalan --. Flag multi-kata menggunakan - (tanda hubung/tanda pisah) sebagai pemisah kata.
Mengikuti konvensi UNIX, jika tanda diulang pada command line, hanya kemunculan paling kanan yang akan berlaku. Tidak ada diagnostik yang dikeluarkan. Hal ini memudahkan penyiapan alias perintah dan skrip wrapper yang memberikan nilai tanda default; nilai yang dapat dengan mudah diganti dengan menentukannya di command line alias atau skrip wrapper.
Tanda Boolean
Meskipun banyak tanda boolean memiliki nilai tersirat false, beberapa tanda boolean memiliki nilai true secara default. Kehadiran --flag menetapkan tanda ke true atau false, bergantung pada nilai yang tersirat oleh nama tanda.
Bendera Bernilai
Flag non-boolean memiliki nilai eksplisit. Nilai dapat ditentukan dengan menempatkan nilai sebagai argumen berikutnya setelah tanda --flag value.
Jika nilainya adalah bilangan bulat, maka nilainya harus 0 atau di atasnya. Integer 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 dicantumkan sebagai output standar biasanya menggunakan format tabel khusus perintah atau format YAML default. Selain itu, tanda --format dapat digunakan untuk mengubah atau mengonfigurasi format output default ini. Nilai output --format yaml, json, dan csv menjamin bahwa penyelesaian perintah yang berhasil 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.