透過 clasp 使用指令列介面

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

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

功能

在本機開發

clasp 可讓您在本機開發 Apps Script 專案。您可以在自己的電腦上編寫程式碼,完成後上傳至 Apps Script。您也可以下載現有的 Apps Script 專案,以便在離線時編輯。由於程式碼位於本機,因此您可以使用 git 等慣用開發工具建構 Apps Script 專案。

管理部署作業版本

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

結構代碼

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 指令。

使用clasp

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

登入

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

clasp login

登出

這個指令會登出指令列工具。你必須使用 clasp login 重新登入,向 Google 重新驗證身分,才能繼續使用 clasp

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>
    

下載指令碼專案

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

clasp pull

上傳指令碼專案

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

clasp push

列出專案版本

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

clasp versions

部署已發布的專案

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

如要使用 clasp 部署專案,請先建立 Apps Script 專案的不可變更版本。版本是指令碼專案的「快照」,類似於唯讀的分支版本。

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 做出貢獻。