การกำหนดค่า
CLI อ่านแต่ละการตั้งค่าจาก flag ตัวแปรสภาพแวดล้อม ไฟล์กำหนดค่าของมัน และค่าเริ่มต้นในตัว และเก็บทุกอย่างไว้ใต้ ~/.polylane หน้านี้แสดงลำดับ ตัวแปร และวิธีควบคุมเทเลเมทรี
ลำดับความสำคัญ
CLI เลือกใช้แต่ละการตั้งค่าตามลำดับนี้ โดยลำดับสูงสุดชนะ:
- flag ของ CLI เช่น
--workspace,--api-key,--outputและ--timeout - ตัวแปรสภาพแวดล้อม: ชุด
POLYLANE_*รวมถึงNO_COLORและDO_NOT_TRACKตามมาตรฐาน - สำหรับข้อมูลรับรองเท่านั้น โทเค็น OAuth ใน
~/.polylane/credentials.json - ไฟล์กำหนดค่าที่
~/.polylane/config.json - ค่าเริ่มต้นในตัว: โดเมน
api.polylane.comtimeout 300 วินาที ผลลัพธ์textในเทอร์มินัลและjsonเมื่อ pipe
POLYLANE_API_KEY ที่ export ไว้จะชนะ ~/.polylane/credentials.json ที่ค้างอยู่เสมอ ดังนั้น CI runner ที่ตั้งตัวแปรนี้ไว้จะไม่หยิบโทเค็น OAuth ที่หลงเหลืออยู่ การยืนยันตัวตนแสดงลำดับเดียวกันสำหรับข้อมูลรับรอง
ไฟล์กำหนดค่า
~/.polylane/config.json รับหกคีย์: domain, workspace_id, api_key, output, timeout และ telemetry จัดการผ่าน CLI: config show พิมพ์การกำหนดค่าที่ resolve แล้ว วิธียืนยันตัวตนที่ใช้อยู่ และ path ของไฟล์ โดยปิดบังคีย์ API
polylane config show
polylane config set --key output --value json
หากต้องการตั้ง workspace เริ่มต้นด้วย slug แทน id ให้รัน polylane workspace use <slug> ข้อมูลรับรอง OAuth อยู่แยกต่างหากใน ~/.polylane/credentials.json และรีเฟรชด้วยตัวเองเมื่อ access token ใกล้หมดอายุ
ตัวแปรสภาพแวดล้อม
| ตัวแปร | คำอธิบาย |
|---|---|
POLYLANE_API_KEY | ยืนยันตัวตนโดยไม่เก็บคีย์บนดิสก์ |
POLYLANE_WORKSPACE_ID | ตั้ง workspace สำหรับเชลล์ปัจจุบัน |
POLYLANE_API_DOMAIN | ชี้ไปยัง hostname ของ API อื่น เฉพาะ hostname ไม่มีโปรโตคอล |
POLYLANE_OUTPUT | บังคับผลลัพธ์เป็น text หรือ json |
POLYLANE_TIMEOUT | timeout ของคำขอเป็นวินาที |
POLYLANE_VERBOSE | เปิด logging แบบละเอียด |
POLYLANE_TELEMETRY=0 | ปิดเทเลเมทรีสำหรับสภาพแวดล้อมนี้ |
DO_NOT_TRACK=1 | การเลือกไม่รับเทเลเมทรีแบบสากล แทนที่การตั้งค่าเทเลเมทรีอื่นทั้งหมด รวมถึงไฟล์กำหนดค่า |
NO_COLOR | ปิดสี ANSI |
เทเลเมทรี
เทเลเมทรีการใช้งานแบบไม่ระบุตัวตนเปิดเป็นค่าเริ่มต้น มันบันทึกชื่อคำสั่ง ชื่อ flag จำนวนอาร์กิวเมนต์ตามตำแหน่ง exit code และหมวดข้อผิดพลาด ระยะเวลา เวอร์ชันของ CLI และ Node รายละเอียดระบบปฏิบัติการ ตัวระบุแบบไม่ระบุตัวตนต่อการติดตั้ง และ id ของ workspace ค่าของ flag อาร์กิวเมนต์ path ของไฟล์ ผลลัพธ์ของคำสั่ง และข้อความข้อผิดพลาดฉบับเต็มไม่รวมอยู่ในนั้น และ polylane telemetry status แสดงอย่างชัดเจนว่าส่งอะไรและส่งไปที่ใด
ปิดถาวรด้วย polylane telemetry disable ซึ่งเขียนลงไฟล์กำหนดค่า หรือปิดต่อสภาพแวดล้อมด้วย POLYLANE_TELEMETRY=0 หรือ DO_NOT_TRACK=1 การตัดสินใจเป็นไปตาม DO_NOT_TRACK แล้ว POLYLANE_TELEMETRY แล้วไฟล์กำหนดค่า แล้วค่าเริ่มต้นคือเปิด ไม่มี flag ต่อการเรียกแต่ละครั้ง
ไฟล์บนดิสก์
ทุกสิ่งที่ CLI เก็บอยู่ใต้ ~/.polylane:
| ไฟล์ | คำอธิบาย |
|---|---|
config.json | การตั้งค่าที่บันทึกไว้: โดเมน workspace คีย์ API ผลลัพธ์ timeout เทเลเมทรี |
credentials.json | โทเค็น OAuth |
telemetry.json | id การติดตั้งแบบไม่ระบุตัวตนและตัวนับการรัน |
update-state.json | สถานะการตรวจสอบการอัปเดต |
ลบไดเรกทอรีนี้เพื่อรีเซ็ต CLI ทั้งหมด id การติดตั้งใหม่จะถูกสร้างในการรันครั้งถัดไป
ที่เกี่ยวข้อง
- การยืนยันตัวตน: วิธีลงชื่อเข้าใช้และวิธีเลือกข้อมูลรับรอง
- การเขียนสคริปต์: สัญญาผลลัพธ์ flag สำหรับสคริปต์ และ exit code