clasp でコマンドライン インターフェースを使用する

Apps Script エディタではなくターミナルから Apps Script プロジェクトを開発して管理するには、clasp というオープンソース ツールを使用します。

clasp Codelab では、clasp のすべての機能の概要を確認できます。

機能

ローカルで開発する

clasp を使用すると、Apps Script プロジェクトをローカルで開発できます。コンピュータ上でコードを記述して、完成後に Apps Script にアップロードできます。既存の Apps Script プロジェクトをダウンロードして、オフラインで編集することもできます。コードはローカルにあるため、Apps Script プロジェクトのビルド時に git などの好みの開発ツールを使用できます。

デプロイ バージョンを管理する

プロジェクトの複数のデプロイを作成、更新、表示できます。

コードを構造化する

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 を引き続き使用するには、clasp login を使用して再ログインし、Google で再認証する必要があります。

clasp logout

新しい Apps Script プロジェクトを作成する

このコマンドは、現在のディレクトリに新しいスクリプトを作成します。スクリプト タイトルは省略可能です。

clasp create [scriptTitle]

このコマンドを実行すると、現在のディレクトリに次の 2 つのファイルも作成されます。

  • スクリプト ID を保存する .clasp.json ファイル。
  • プロジェクト メタデータを含む appsscript.json プロジェクト マニフェスト ファイル。

既存のプロジェクトのクローンを作成する

このコマンドは、現在のディレクトリに既存のプロジェクトのクローンを作成します。スクリプトは、Google アカウントで作成するか、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 に貢献する。