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 アカウントで作成するか、共有する必要があります。クローンを作成するスクリプト プロジェクトは、スクリプト ID を指定して指定します。

プロジェクトのスクリプト ID を確認する手順は次のとおりです。

  1. Apps Script プロジェクトを開きます。
  2. 左側の [プロジェクト設定] をクリックします。

  3. [ID] でスクリプト ID をコピーします。

     clasp clone <scriptId>

スクリプト プロジェクトをダウンロードする

このコマンドは、Apps Script プロジェクトを Google ドライブからパソコンのファイル システムにダウンロードします。

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 に貢献する。