このページは Cloud Translation API によって翻訳されました。

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 を確認する手順は次のとおりです。

Apps Script プロジェクトを開きます。
左側にある [プロジェクトの設定] をクリックします。
[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 に投稿してください。

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

機能