Skip to content
Apothem
Referensi CLI

completion

Referensi CLI untuk perintah apothem completion.

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

Ringkasan

apothem completion bash|zsh|fish|powershell

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

Shell yang didukung

ShellCara skrip dihasilkan
bashSkrip pelengkapan bash native milik Click.
zshSkrip pelengkapan zsh native milik Click.
fishSkrip pelengkapan fish native milik Click.
powershellSkrip Register-ArgumentCompleter yang dihasilkan oleh kelas pelengkapan PowerShell yang didaftarkan Apothem ke Click (Click tidak menyertakannya secara native), yang menjalankan protokol pelengkapan yang sama dengan shell lainnya.

Meminta shell lain apa pun keluar dengan 64 beserta daftar shell yang didukung.

Mengaktifkan pelengkapan per shell

Perintah apothem harus berada di PATH Anda terlebih dahulu. Pemasang sekali-jalan menulis shim apothem ke $HOME/.local/bin (POSIX) atau %LOCALAPPDATA%\Microsoft\WindowsApps (Windows) dan tidak pernah menyunting PATH Anda, jadi tambahkan direktori itu jika belum tercantum. Lalu aktifkan pelengkapan dengan menambahkan skrip ke berkas pelengkapan shell dan memulai ulang shell:

# bash — append to your bashrc
apothem completion bash >> ~/.bashrc

# zsh — append to your zshrc
apothem completion zsh >> ~/.zshrc

# fish — write to the fish completions directory
apothem completion fish > ~/.config/fish/completions/apothem.fish
# PowerShell — append the completer registration to your profile
apothem completion powershell >> $PROFILE

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

Mengapa bersifat opt-in

Apothem tidak pernah diam-diam menyunting berkas startup shell milik operator. Pemasang mencetak petunjuk satu baris yang menunjuk ke perintah ini; operator memutuskan apakah akan mengaktifkan pelengkapan dan berkas mana yang akan ditambahi. Hal 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, --helpMenampilkan bantuan dan keluar.

Kode keluar

KodeArti
0Skrip pelengkapan dipancarkan
64Shell yang tidak didukung diminta, atau galat penggunaan lainnya seperti opsi yang tidak dikenal. completion tidak memiliki mode --json: perintah ini mencetak skrip, dan memberikan --json itu sendiri merupakan galat penggunaan.

Lihat juga

On this page