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>

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

このコマンドにより、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 に投稿してください。