CLI

驗證

用你的瀏覽器、裝置代碼或API金鑰登入CLI,並為指令碼與CI設定憑證。

CLI透過你的瀏覽器、裝置代碼或API金鑰登入,在指令碼與CI中則從旗標或環境變數讀取憑證。執行polylane auth login以互動方式選擇方式,或傳入旗標略過選擇器。

登入方式

方式指令說明
瀏覽器polylane auth login供互動使用。CLI開啟你的瀏覽器,在localhost回呼上接收權杖,並在權杖到期時刷新它們。
裝置代碼polylane auth login --no-browser供SSH與無瀏覽器的機器使用。CLI印出一個URL與一個代碼;在任何裝置上開啟該URL、輸入代碼,CLI會輪詢直到你核准。
API金鑰polylane auth login --api-key sk_xxxxx供指令碼、CI與代理使用。CLI驗證金鑰並連同預設工作區一起儲存。

登入後,CLI會顯示你是誰,如果你屬於多個工作區,會請你選擇一個預設工作區,儲存為~/.polylane/config.json中的workspace_id。用polylane auth refresh強制刷新權杖。

API金鑰

在Settings > API Keys底下用Create an API key建立一把金鑰:命名它、選擇它的範圍並複製它,因為它只顯示一次。金鑰以sk_開頭。在CI中,改為在環境中設定POLYLANE_API_KEY而不執行登入步驟,或在單次呼叫上傳入全域旗標--api-key <key>。

憑證優先順序

當存在多個憑證時,CLI依這個順序解析:

  1. 目前指令上的--api-key旗標
  2. POLYLANE_API_KEY環境變數
  3. ~/.polylane/credentials.json中的OAuth憑證
  4. ~/.polylane/config.json中的api_key

匯出的POLYLANE_API_KEY永遠勝過過時的~/.polylane/credentials.json,所以設定了該變數的CI執行器不會撿到殘留的OAuth權杖。polylane auth status顯示目前使用的是哪個來源。

檢查與切換

Terminal
polylane auth status
polylane auth whoami
polylane auth logout

auth status顯示使用中的方式、遮罩過的權杖、使用者與工作區;auth whoami顯示目前的使用者。auth logout在確認後撤銷OAuth權杖並清除儲存的憑證,--yes可略過確認;要切換帳戶,登出後用另一組憑證登入。

環境變數

變數說明
POLYLANE_API_KEY供非互動驗證使用的API金鑰
POLYLANE_WORKSPACE_ID預設工作區(ws_ ID)
POLYLANE_API_DOMAIN覆寫API主機名稱

在你不想寫入~/.polylane/的CI工作與容器中使用這些變數。設定列出完整的集合。

相關頁面

  • 設定:完整的優先順序、每個環境變數與磁碟上的檔案。
  • 指令碼:JSON輸出、結束代碼,以及供CI與代理使用的旗標。
  • API金鑰與OAuth:範圍、金鑰管理與OAuth客戶端。