Skip to content
Apothem
Referensi CLI

completion

Referensi CLI untuk perintah apothem completion.

Mencetak skrip pelengkapan-shell untuk shell yang diminta ke output standar. Mengaktifkan pelengkapan bersifat opt-in: perintah ini hanya mencetak skrip — ia tidak pernah menyunting berkas startup shell Anda. Anda sendiri yang menambahkan output ke berkas pelengkapan shell.

Ringkasan

apothem completion bash|zsh|fish|powershell

Skrip yang dipancarkan mengaktifkan pelengkapan <TAB> untuk subperintah dan flag apothem, dan — untuk opsi --harness — untuk id harness yang terdaftar plus all.

Shell yang didukung

ShellCara skrip dihasilkan
bashSkrip pelengkapan bash asli dari Click.
zshSkrip pelengkapan zsh asli dari Click.
fishSkrip pelengkapan fish asli dari Click.
powershellSebuah cuplikan Register-ArgumentCompleter yang menjembatani ke protokol pelengkapan Click (Click tidak menyertakan skrip PowerShell asli, jadi cuplikan ini menyambungkan protokol yang sama ke PowerShell).

Meminta shell lain mana pun keluar dengan 2 beserta daftar shell yang didukung.

Mengaktifkan pelengkapan per shell

Pertama, perintah apothem harus berada di PATH Anda (pemasang sekali-jalan menempatkannya di sana). Lalu aktifkan pelengkapan dengan menambahkan skrip ke berkas pelengkapan shell dan memulai ulang shell:

# bash — tambahkan ke bashrc Anda
apothem completion bash >> ~/.bashrc

# zsh — tambahkan ke zshrc Anda
apothem completion zsh >> ~/.zshrc

# fish — tulis ke direktori pelengkapan fish
apothem completion fish > ~/.config/fish/completions/apothem.fish
# PowerShell — tambahkan registrasi pelengkap ke profil Anda
apothem completion powershell >> $PROFILE

Untuk mencoba pelengkapan hanya pada sesi saat ini tanpa menyunting berkas apa pun, lakukan source skrip secara langsung (bash/zsh): source <(apothem completion bash).

Mengapa bersifat opt-in

Apothem tidak pernah diam-diam menyunting berkas startup shell seorang operator. Pemasang mencetak petunjuk satu baris yang menunjuk ke perintah ini; operator memutuskan apakah akan mengaktifkan pelengkapan dan ke berkas mana menambahkannya. Ini menjaga jejak pemasangan tetap dapat diprediksi dan dapat dibalik — menghapus blok yang ditambahkan akan menonaktifkan pelengkapan.

Opsi

OpsiDeskripsi
SHELLSalah satu dari bash, zsh, fish, powershell (argumen posisional wajib).
-h, --helpTampilkan bantuan dan keluar.

Kode keluar

KodeArti
0Skrip pelengkapan dipancarkan
2Shell yang tidak didukung diminta

Lihat juga

On this page