이름
gdcloud topic command-conventions - gdcloud 명령 규칙에 관한 추가 도움말입니다.
설명
gdcloud CLI 명령어 디자인은 일반적인 원칙과 규칙을 따릅니다. 이 문서에서는 이러한 기능을 자세히 설명합니다.
관례는 규칙이 아닌 목표입니다. 예외가 있는 경우 --help 플래그를 사용하여 개별 명령어에 제공된 정보를 참고하세요.
명령어 계층 구조
gdcloud CLI 명령어는 gdcloud를 루트로, 내부 노드에 명령어 그룹을, 리프 노드에 명령어를 갖는 트리로 구성됩니다. 그룹 명령어는 실행할 수 있지만 도움말 텍스트를 표시하는 데만 사용할 수 있습니다.
모든 그룹과 명령어에는 도움말 텍스트를 표준 출력으로 표시하는 --help 플래그가 있습니다. 도움말 텍스트는 실행 중인 실행 파일에서 파생되므로 여러 출시 설치 간에 전환할 때도 항상 최신 상태입니다.
명령줄
모든 gdcloud 명령어는 동일한 형식을 따릅니다.
gdcloud GROUP GROUP ... COMMAND POSITIONAL ... FLAG ...
플래그와 위치 인수는 혼합할 수 있지만 일관성을 위해 일반적으로 위치 인수가 순서대로 먼저 표시되고 플래그는 순서에 상관없이 표시됩니다.
명령어 사용 표기법
명령어 사용은 전체 명령어 이름, 위치 인수, 플래그 인수를 그룹 정렬 순서로 포함하는 약식 표기법입니다. 선택적 인수는 [ ... ]로 묶여 있습니다. 예를 들면 다음과 같습니다.
gdcloud foo bar NAME [--format=FORMAT]
필수 NAME 위치 인수, 선택적 EXTRA 위치 인수, 선택적 --format 플래그 인수가 있는 gdcloud foo bar 명령어의 사용법입니다.
위치 인수
위치 인수는 순서가 지정되어 있으며 명령어 사용 및 도움말 문서 인수 정의 목록에 나열된 순서대로 지정해야 합니다.
플래그 인수
플래그 이름은 소문자이며 -- 접두사가 있습니다. 여러 단어로 된 플래그는 - (하이픈/대시)을 단어 구분 기호로 사용합니다.
UNIX 규칙에 따라 명령줄에서 플래그가 반복되면 가장 오른쪽에 있는 항목만 적용됩니다. 진단이 발생하지 않습니다. 이렇게 하면 기본 플래그 값을 제공하는 명령 별칭과 래퍼 스크립트를 쉽게 설정할 수 있습니다. 별칭 또는 래퍼 스크립트 명령줄에서 지정하여 쉽게 재정의할 수 있는 값입니다.
불리언 플래그
많은 불리언 플래그의 암시적 값은 false이지만 일부는 기본적으로 true입니다. --flag가 있으면 플래그 이름이 암시하는 값에 따라 플래그가 true 또는 false로 설정됩니다.
가치 있는 플래그
불리언이 아닌 플래그에는 명시적 값이 있습니다. 값은 플래그 --flag value 뒤에 값을 다음 인수로 배치하여 지정할 수 있습니다.
값이 정수인 경우 0 이상이어야 합니다. 음수 정수는 허용되지 않습니다.
출력
표준 출력은 명령어에서 요청한 명시적 정보를 위한 것입니다.
컨텍스트에 따라 결정적 파싱을 지원하기 위해 출력 형식에 보장이 있을 수 있습니다. 특정 명령어는 리소스를 반환하며 이러한 리소스는 일반적으로 명령어별 테이블 형식 또는 기본 YAML 형식을 사용하여 표준 출력으로 나열됩니다. 또한 --format 플래그를 사용하여 이러한 기본 출력 형식을 변경하거나 구성할 수 있습니다. yaml, json, csv 출력 --format 값은 명령어가 성공적으로 완료되면 각 형식을 사용하여 파싱할 수 있는 표준 출력 데이터가 생성되도록 보장합니다. --format 플래그의 기능에 대한 자세한 설명은 gdcloud topic formats 명령어를 통해 확인할 수 있습니다. 리소스를 반환하지 않는 명령어의 경우 출력은 명령어의 --help 플래그에 정의됩니다.
표준 오류는 진단을 위해 예약되어 있습니다. 일반적으로 표준 오류 데이터의 형식은 출시마다 변경될 수 있습니다. 사용자는 특정 콘텐츠 또는 표준 오류에 대한 출력의 존재에 대해 스크립트를 작성해서는 안 됩니다. 신뢰할 수 있는 유일한 오류 표시기는 종료 상태입니다.
포착되지 않은 예외로 인해 gdcloud CLI 명령어가 비정상 종료되어서는 안 됩니다. 하지만 gdcloud CLI가 비정상 종료되면 스택 트레이스가 가로채서 로그 파일에 기록되고 비정상 종료 진단이 표준 오류에 기록됩니다.
종료 상태
종료 상태 0은 성공을 나타냅니다. 다른 종료 상태는 오류를 나타냅니다. 명령어별 진단에서 오류의 특성과 수정 방법을 설명합니다.