CLI

구성

CLI가 설정을 읽는 위치, 인식하는 환경 변수, 텔레메트리를 제어하는 방법입니다.

CLI는 각 설정을 플래그, 환경 변수, 구성 파일, 내장 기본값에서 읽고, 모든 것을 ~/.polylane 아래에 저장합니다. 이 페이지는 그 순서, 변수, 텔레메트리 제어 방법을 나열합니다.

우선순위

CLI는 각 설정을 다음 순서로 결정하며, 높은 것이 이깁니다:

  1. CLI 플래그. 예를 들어 --workspace, --api-key, --output, --timeout.
  2. 환경 변수: POLYLANE_* 집합과 표준 NO_COLOR, DO_NOT_TRACK.
  3. 자격 증명에 한해, ~/.polylane/credentials.json의 OAuth 토큰.
  4. ~/.polylane/config.json의 구성 파일.
  5. 내장 기본값: 도메인 api.polylane.com, 타임아웃 300초, 출력은 터미널에서 text, 파이프에서 json.

내보낸 POLYLANE_API_KEY는 오래된 ~/.polylane/credentials.json보다 항상 우선하므로, 변수가 설정된 CI 러너는 남아 있는 OAuth 토큰을 집어 들지 않습니다. 인증에 자격 증명에 대한 같은 순서가 나열되어 있습니다.

구성 파일

~/.polylane/config.json은 여섯 개의 키를 받습니다: domain, workspace_id, api_key, output, timeout, telemetry. CLI로 관리하세요: config show는 결정된 구성, 사용 중인 인증 방법, 파일 경로를 API 키를 마스킹해 출력합니다.

Terminal
polylane config show
polylane config set --key output --value json

기본 워크스페이스를 id 대신 슬러그로 설정하려면 polylane workspace use <slug>를 실행하세요. OAuth 자격 증명은 ~/.polylane/credentials.json에 따로 있으며, 액세스 토큰이 만료에 가까워지면 스스로 갱신됩니다.

환경 변수

변수설명
POLYLANE_API_KEY디스크에 키를 저장하지 않고 인증
POLYLANE_WORKSPACE_ID현재 셸의 워크스페이스 설정
POLYLANE_API_DOMAIN다른 API 호스트 이름 지정. 프로토콜 없이 호스트 이름만
POLYLANE_OUTPUTtext 또는 json 출력 강제
POLYLANE_TIMEOUT요청 타임아웃(초)
POLYLANE_VERBOSE상세 로깅 활성화
POLYLANE_TELEMETRY=0이 환경에서 텔레메트리 비활성화
DO_NOT_TRACK=1범용 텔레메트리 옵트아웃. 구성 파일을 포함한 다른 모든 텔레메트리 설정보다 우선
NO_COLORANSI 색상 비활성화

텔레메트리

익명 사용 텔레메트리는 기본으로 켜져 있습니다. 명령 이름, 플래그 이름, 위치 인수의 개수, 종료 코드와 오류 범주, 소요 시간, CLI와 Node 버전, 운영 체제 정보, 설치별 익명 식별자, 워크스페이스 id를 기록합니다. 플래그 값, 인수, 파일 경로, 명령 출력, 전체 오류 메시지는 포함되지 않으며, polylane telemetry status가 무엇이 어디로 전송되는지 정확히 보여 줍니다.

polylane telemetry disable로 영구히 끄면 구성 파일에 기록되고, 환경별로는 POLYLANE_TELEMETRY=0 또는 DO_NOT_TRACK=1로 끕니다. 결정은 DO_NOT_TRACK, POLYLANE_TELEMETRY, 구성 파일, 기본값(켜짐) 순으로 따릅니다. 호출별 플래그는 없습니다.

디스크의 파일

CLI가 저장하는 모든 것은 ~/.polylane 아래에 있습니다:

파일설명
config.json저장된 설정: 도메인, 워크스페이스, API 키, 출력, 타임아웃, 텔레메트리
credentials.jsonOAuth 토큰
telemetry.json익명 설치 id와 실행 카운터
update-state.json업데이트 확인 상태

CLI를 완전히 초기화하려면 디렉터리를 삭제하세요. 다음 실행 시 새 설치 id가 생성됩니다.

관련 문서

  • 인증: 로그인 방법과 자격 증명이 선택되는 방식.
  • 스크립팅: 출력 계약, 스크립트 플래그, 종료 코드.