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

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

要件

claspNode.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

公開したプロジェクトをデプロイする

スクリプト プロジェクトは、ウェブアプリ、アドオン、実行可能ファイルとしてデプロイできます。Deployment を作成するには、スクリプト エディタ、プロジェクト マニフェスト、または 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 オープンソース プロジェクトに貢献する

GitHubclasp にコントリビューション