completion
apothem completion 명령에 대한 CLI 참조.
요청한 셸의 셸 자동 완성 스크립트를 stdout으로 출력합니다. 자동 완성 활성화는 옵트인입니다. 이 명령은 스크립트를 출력하기만 하며, 셸 시작 파일을 절대 편집하지 않습니다. 출력을 셸의 자동 완성 파일에 추가하는 일은 여러분이 직접 합니다.
개요
apothem completion bash|zsh|fish|powershell출력된 스크립트는 apothem 하위 명령, 플래그, 그리고 --harness 옵션의 경우
등록된 하니스 ID와 all에 대해 <TAB> 자동 완성을 활성화합니다.
지원되는 셸
| 셸 | 스크립트 생성 방식 |
|---|---|
bash | Click의 네이티브 bash 자동 완성 스크립트. |
zsh | Click의 네이티브 zsh 자동 완성 스크립트. |
fish | Click의 네이티브 fish 자동 완성 스크립트. |
powershell | Apothem이 Click에 등록하는 PowerShell 자동 완성 클래스가 생성하는 Register-ArgumentCompleter 스크립트(Click은 네이티브로 제공하는 것이 없음)로, 다른 셸과 같은 자동 완성 프로토콜을 구동합니다. |
그 밖의 셸을 요청하면 지원되는 셸 목록과 함께 64로 종료합니다.
셸별 자동 완성 활성화
먼저 apothem 명령이 PATH에 있어야 합니다. 원샷 설치 프로그램은 apothem 심을
$HOME/.local/bin(POSIX) 또는 %LOCALAPPDATA%\Microsoft\WindowsApps(Windows)에
쓰고 PATH는 절대 편집하지 않으므로, 그 디렉터리가 아직 목록에 없다면
추가하세요. 그런 다음 스크립트를 셸의 자동 완성 파일에 추가하고 셸을 다시
시작하여 자동 완성을 활성화합니다.
# 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어떤 파일도 편집하지 않고 현재 세션에서만 자동 완성을 시험해 보려면, 스크립트를
직접 source하세요(bash/zsh): source <(apothem completion bash).
옵트인 방식인 이유
Apothem은 운영자의 셸 시작 파일을 절대 조용히 편집하지 않습니다. 설치 프로그램은 이 명령을 가리키는 한 줄짜리 힌트를 출력하며, 자동 완성을 활성화할지와 어느 파일에 추가할지는 운영자가 결정합니다. 이렇게 하면 설치의 흔적이 예측 가능하고 되돌릴 수 있게 유지됩니다. 추가한 블록을 제거하면 자동 완성이 비활성화됩니다.
옵션
| 옵션 | 설명 |
|---|---|
SHELL | bash, zsh, fish, powershell 중 하나(필수 위치 인수). |
-h, --help | 도움말을 표시하고 종료합니다. |
종료 코드
| 코드 | 의미 |
|---|---|
| 0 | 자동 완성 스크립트 출력됨 |
| 64 | 지원되지 않는 셸을 요청했거나, 알 수 없는 옵션과 같은 그 밖의 사용법 오류. completion에는 --json 모드가 없습니다. 이 명령은 스크립트를 출력하며, --json을 전달하는 것 자체가 사용법 오류입니다. |
함께 보기
- apothem install — 하니스 구성을 설치
- apothem harnesses —
--harness자동 완성이 제안하는 하니스 ID - CLI 참조 — 모든 하위 명령