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|powershellSkrip yang dipancarkan mengaktifkan pelengkapan <TAB> untuk subperintah dan
flag apothem, serta — untuk opsi --harness — ID harness yang terdaftar
ditambah all.
Shell yang didukung
| Shell | Cara skrip dihasilkan |
|---|---|
bash | Skrip pelengkapan bash native milik Click. |
zsh | Skrip pelengkapan zsh native milik Click. |
fish | Skrip pelengkapan fish native milik Click. |
powershell | Skrip 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 >> $PROFILEUntuk 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
| Opsi | Deskripsi |
|---|---|
SHELL | Salah satu dari bash, zsh, fish, powershell (argumen posisional wajib). |
-h, --help | Menampilkan bantuan dan keluar. |
Kode keluar
| Kode | Arti |
|---|---|
| 0 | Skrip pelengkapan dipancarkan |
| 64 | Shell 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
- apothem install — memasang konfigurasi harness
- apothem harnesses — ID harness yang ditawarkan pelengkapan
--harness - Referensi CLI — semua subperintah