claspの導入
インストール
以下コマンドを実行でインストールします。
npm i @google/clasp -gレスポンス
changed 257 packages in 16s
84 packages are looking for funding
run `npm fund` for detailsログイン
ログインする前に、
Google Apps Script API を
有効にしておく必要があります。
https://script.google.com/home/usersettings
上記にアクセスして、「オン」に
なっていることを確認してください。
以下コマンドを実行でログインします。
clasp loginレスポンス
Warning: You seem to already be logged in.
`🔑 Authorize clasp by visiting this url: https://accounts.google.com/o/oauth2/v2/auth?...........com
You are logged in as [あなたのGメールアドレス].プロジェクトの新規作成
以下コマンドを実行で新規作成します。
clasp create --title "ファイル名" --type タイプ| タイプ | 説明 |
|---|---|
| standalone | スタンダードの状態 |
| docs | Google Docsに紐づけ |
| sheets | Google Sheetsに紐づけ |
| slides | Google Slidesに紐づけ |
| forms | Google Formsに紐づけ |
| webapp | Webアプリケーションとして作成 |
| api | API実行可能ファイル |
既存プロジェクトをクローン
以下コマンドを実行で既存プロジェクトをクローンします。
clasp clone <スクリプトID>※必ず、作業ディレクトリを作成し、移動して行ってください。
どこにいったか分からなくなります。
GoogleAppsScriptにプッシュする
以下コマンドを実行でプッシュできます。
clasp pushclasp コマンドリファレンス
Google Apps Script CLIツール (clasp) のコマンド一覧
認証・ログイン
| コマンド | 書き方例 | 解説 |
|---|---|---|
logout | clasp logout | claspからログアウト |
show-authorized-user | clasp show-authorized-user | 現在の認証状態とユーザー情報を表示 |
プロジェクト管理
| コマンド | 書き方例 | 解説 |
|---|---|---|
create-script / create | clasp create --title "MyProject" --type standalone | 新しいスクリプトプロジェクトを作成 |
clone-script / clone | clasp clone 1pL4ojTsowQtmyagCKXmGjvZ | 既存のスクリプトをローカルにクローン |
delete-script / delete | clasp delete | プロジェクトを削除 |
list-scripts / list | clasp list | 自分のApps Scriptプロジェクト一覧を表示 |
ファイル操作
| コマンド | 書き方例 | 解説 |
|---|---|---|
push | clasp push<br>clasp push --watch | ローカルのファイルをGoogle Apps Scriptにアップロード<br>--watchで自動同期 |
pull | clasp pull | Google Apps Scriptからファイルをダウンロード |
show-file-status / status | clasp status | プッシュされる予定のファイル一覧を表示 |
デプロイ
| コマンド | 書き方例 | 解説 |
|---|---|---|
create-deployment / deploy | clasp deploy<br>clasp deploy --description "v1.0" | プロジェクトをデプロイ（公開） |
list-deployments / deployments | clasp deployments | デプロイメント一覧を表示 |
update-deployment / redeploy | clasp redeploy AKfycbz... | 既存のデプロイメントを更新 |
delete-deployment / undeploy | clasp undeploy AKfycbz... | デプロイメントを削除 |
バージョン管理
| コマンド | 書き方例 | 解説 |
|---|---|---|
create-version / version | clasp version "初回リリース" | スクリプトの不変バージョンを作成 |
list-versions / versions | clasp versions | バージョン履歴を表示 |
実行とログ
| コマンド | 書き方例 | 解説 |
|---|---|---|
run-function / run | clasp run myFunction<br>clasp run myFunction --params '[1,2,3]' | 指定した関数を実行 |
open-logs | clasp open-logs | Google Cloud Platformのログコンソールを開く |
setup-logs | clasp setup-logs | Cloud Loggingをセットアップ |
tail-logs / logs | clasp logs<br>clasp logs --simplified | 最新のログエントリを表示 |
ブラウザで開く
| コマンド | 書き方例 | 解説 |
|---|---|---|
open-script | clasp open-script | Apps Script IDEをブラウザで開く |
open-container | clasp open-container | コンテナバインドスクリプトのIDEを開く |
open-web-app | clasp open-web-app | デプロイ済みWebアプリをブラウザで開く |
API管理
| コマンド | 書き方例 | 解説 |
|---|---|---|
list-apis / apis | clasp apis | 有効化されているAPI一覧を表示 |
enable-api | clasp enable-api sheets | 指定したAPIを有効化 |
disable-api | clasp disable-api sheets | 指定したAPIを無効化 |
open-api-console | clasp open-api-console | GCPのAPIコンソールを開く |
open-credentials-setup | clasp open-credentials-setup | 認証情報ページを開く |
その他
| コマンド | 書き方例 | 解説 |
|---|---|---|
start-mcp-server / mcp | clasp mcp | MCPサーバーを起動してApps Scriptと対話 |
help | clasp help<br>clasp help push | ヘルプを表示 |
よく使う基本的なワークフロー
新規プロジェクト作成
# プロジェクト作成
clasp create --title "MyProject" --type standalone
# コードファイルを作成
echo 'function myFunction() { Logger.log("Hello!"); }' > Code.js
# プッシュ
clasp push
# ブラウザで開く
clasp open-script既存プロジェクトの編集
# 既存プロジェクトをクローン
clasp clone <スクリプトID>
# ファイルを編集
nano Code.js
# Google Apps Scriptにプッシュ
clasp push
# ブラウザでスクリプトエディタを開く
clasp open-script
# ログを確認
clasp logs自動同期モード
# ファイル変更を監視して自動プッシュ
clasp push --watch
コメント