2024-12-18
주간 코드 리뷰에서 자주 나오는 CLI 인자 설계
작성: 오지후
CLI는 사용자가 “읽을 수 있는 오류 메시지”를 가장 가까이에서 마주칩니다. 인자 설계가 산만하면 팀 채널에 같은 질문이 반복됩니다.
기본 경로는 현재 디렉터리가 아니라 명시적 플래그로 받는 편이 안전합니다. 상호 배타 옵션은 그룹으로 묶어 argparse나 Typer에서 충돌을 초기에 차단합니다. 프리플라이트는 네트워크 호출 전에 로컬 파일 존재와 권한을 확인합니다.
리뷰 코멘트를 모아 보니, “짧은 예시 커맨드 세 줄”을 README 상단에 두었을 때 문의가 가장 크게 줄었습니다.
이 글은 특정 수익 결과를 약속하지 않으며, 팀 생산성을 끌어올리는 구체적 패턴에 초점을 둡니다.
#CLI#리뷰#도구