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

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

clasp Codelab では、 clasp の機能。

機能

ローカルで開発する

clasp を使用すると、Apps Script プロジェクトをローカルで開発できます。Google Chat では 自分のパソコンでコードを記述して、いつでもどこでも できます。既存の Apps Script プロジェクトをダウンロードして、編集することもできます。 オフラインでも表示できます。コードはローカルなので、好みのものを使用して Apps Script のビルド時に使用する git などの開発ツール できます。

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

マルチ イベントの作成、更新、表示 Deployment を表します。

コードを構造化する

clasp を使用すると、保持されるディレクトリにコードを整理できる アップロードする際に使用します次に例を示します。

# 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 アカウントの 定義できます。実行すると、Google Cloud コンソールへのログインを 管理する方法です。

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

公開済みのプロジェクトをデプロイする

スクリプト プロジェクトは、ウェブアプリ、アドオン、実行可能ファイルとしてデプロイできます。Google Chat では スクリプト エディタでデプロイメントを作成する プロジェクトのマニフェストで宣言するか、clasp を使用します。

clasp を使用してプロジェクトをデプロイするには、まず不変バージョンのアプリを作成します。 スクリプト プロジェクト。バージョンは「スナップショット」スクリプト プロジェクトのものとほぼ同じです。 ブランチ型リリースになります

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