透過 clasp 使用指令列介面

透過終端機開發及管理 Apps Script 專案,而非使用 Apps Script 編輯器,您可以使用名為 clasp 的開放原始碼工具。

clasp 程式碼研究室會概略介紹所有 clasp 功能。

功能

在本機開發

clasp 可讓您在本機開發 Apps Script 專案。你可以 在自己的電腦上編寫程式碼,然後在程式語言中上傳至 Apps Script 完成。您也可以下載現有的 Apps Script 專案,以便進行編輯 讓您在離線狀態下使用這些方法由於程式碼是本機程式碼,您可以使用喜愛的程式碼 建構 Apps Script 時,使用 git 等開發工具 Google Cloud 的 Resource Manager 工具 經特別設計,能以程式輔助方式協助您管理專案

管理部署版本

建立、更新及查看專案的多個部署

結構程式碼

clasp 可讓您將程式碼分類至目錄,並在您將程式碼上傳至 script.google.com 時保留這些目錄。例如:

# On script.google.com:
├── tests/slides.gs
└── tests/sheets.gs

# Locally:
├── tests/
│   ├─ slides.gs
│   └─ sheets.gs

需求條件

clasp 是以 Node.js 編寫,並透過下列方式發布 npm 工具。使用「clasp」前,你必須擁有 已安裝 Node.js 4.7.4 以上版本。 您必須具備管理員權限,才能安裝 Node.js。

安裝

安裝 Node.js 後,您可以使用下列 npm 指令安裝 clasp

npm install @google/clasp -g

安裝完成後,您可以在clasp 您也能選擇重設 VM 這類似於按下電腦的重設按鈕

使用clasp

您可以使用 clasp 從指令列處理各種工作。本節將說明您在使用 clasp 開發時可使用的常見作業。

登入

這個指令會記錄並授權管理您 Google 帳戶的 Apps Script 專案。執行後,系統會要求您登入 。

clasp login

登出

此指令會將命令列工具登出。您必須使用以下電子郵件地址重新登入 繼續使用「clasp」之前,請clasp login向 Google 重新驗證。

clasp logout

建立新的 Apps Script 專案

這個指令會在目前的目錄中建立新的指令碼,並視需求加上 指令碼標題。

clasp create [scriptTitle]

這個指令也會在目前目錄中建立兩個檔案:

  • 儲存指令碼 ID 的 .clasp.json 檔案。
  • 含有專案中繼資料的 appsscript.json 專案資訊清單檔案。

複製現有專案

這個指令會複製目前目錄中的現有專案。您必須使用自己的 Google 帳戶建立或共用指令碼。由您指定指令碼 要複製的專案,請提供指令碼 ID。

如要尋找專案的指令碼 ID,請按照下列步驟操作:

  1. 開啟 Apps Script 專案。
  2. 按一下左側的「專案設定」圖示
  3. 在 ID 下方複製指令碼 ID。

     clasp clone <scriptId>
    

下載指令碼專案

這個指令會將 Apps Script 專案從 Google 雲端硬碟下載到電腦的檔案系統。

clasp pull

上傳指令碼專案

這個指令會將電腦中的所有指令碼專案檔案上傳至 Google 雲端硬碟。

clasp push

列出專案版本

這個指令會列出每個指令碼專案版本的編號和說明。

clasp versions

部署已發布的專案

您可以將指令碼專案部署為網頁應用程式、外掛程式或執行檔。你可以 在指令碼編輯器中建立部署。 寫入專案資訊清單中,或使用 clasp

如要使用 clasp 部署專案,請先建立應用程式的不可變版本 指令碼專案。版本就是「快照」類似下方的文字 唯讀分支版本。

clasp version [description]

這個指令會顯示新建立的版本號碼。使用該號碼 可以部署及取消部署專案的執行個體:

clasp deploy [version] [description]
clasp undeploy <deploymentId>

這個指令會使用新版本和說明來更新現有的部署作業:

clasp redeploy <deploymentId> <version> <description>

列出部署作業

這個指令會列出指令碼專案的部署 ID、版本及其 說明

clasp deployments

在 Apps Script 編輯器中開啟專案

這個指令會在 Apps Script 編輯器中開啟指令碼專案。編輯器是 會在預設網路瀏覽器中以新分頁開啟。

clasp open

協助改善 clasp 開放原始碼專案

協助改善 GitHub 上的 clasp