Node.js、Claspの順にインストールしていきます。
Claspをインストール
node.jsを入れる
ダウンロード
OSにより選択してください。
Windowsの64bit版の場合
公式サイトにアクセス
左側の「推奨版」を任意の場所にダウンロード
※当記事の執筆時点で、推奨版は12.18.4 LTSです。
それ以外の場合
公式サイトのバージョン一覧にアクセス
「推奨版」タブから、自分のOSや目的に合うものを任意の場所にダウンロード
例えばWindowsの32bit版であれば、画像中央あたりの
Windows Installer (.msi)
の32-bit
版が良いようです。
インストール
インストーラを起動して、画面の指示に従い
Node.js
をインストールする詳しい手順はこちら↓が参考になるかと思います。
claspを使う事前準備-Node.jsをインストールする – 経理業務向けGoogle Apps Script講座Node.js
を入れる過程で、このあと使用するnpm
というツールもインストールされます。
バージョンを確認
Node.js
のインストールができたら、ターミナルを起動する特に理由が無ければ
PowerShell
かGit Bash
がおすすめです。
以下、原則Git Bash
を使用する場合を前提に説明します。下記のコマンドを入力して、インストールができているか確認する
npm -v
こんな風に
npm
のバージョンが出力されればOK。※バージョンは執筆時点のものです。
6.9.0
Claspを入れる
インストール
npm
というNode.js版のパッケージ管理ツールを使用してClasp
をインストールします。
※PowerShell用の記事ですが、「パッケージとは何ぞや?」な方はこちらへ。
【PowerShell】「そもそもパッケージって何?」っていうあなたに、少し説明します。 - ゆるおたノート
- 下記のコマンドを入力して、Google社が配布している
Clasp
の公式パッケージ(@google/clasp
)をインストールnpm i @google/clasp -g
コマンドの意味
npm i [パッケージ名]
で、「パッケージをダウンロードしてインストールする」という意味のコマンドです。
# パッケージをインストール npm i [パッケージ名]
インストール先はカレントディレクトリの周辺(参考)で、基本はプロジェクト内の展開になると思います。
そこに-g
というオプションをつけると、展開範囲は「OSのユーザー単位(=グローバル)」になります。
# パッケージをグローバルでインストール npm i [パッケージ名] -g
パッケージ自体のインストール先も「npm
のインストール場所」に変更されます。
ちなみにi
はinstall
のショートハンドなので、下記のように書いてもOKです。
# パッケージをグローバルでインストール npm install -g [パッケージ名]
バージョンを確認
インストールが出来たら、念のためClasp
が正しくインストール出来ているか確認します。
Clasp
のバージョンを確認※バージョンは執筆時点のものです。
# 入力 clasp -v # 出力(例) 2.1.0
「そんなコマンドは無いよ」と言われたら…
Claspのコマンドを使用する時、コマンドがシェル*1に登録できていないと下記のようなエラー文が出力されます。
command not found
コマンドが見つかりません。
この場合は、Claspのコマンド達を「Claspという名のコマンド」として端末に登録して、シェルがClaspコマンドを認識できるようにしておく必要があります。
書き方は、こんな感じ。
# コマンドを登録する alias [コマンド名]=[ソースコード]
alias
は、別名・通称という意味です。「エイリアス」と読むことが多いと思います。
Claspを登録する場合は、こんな感じに書きます。
# Claspコマンドを登録する alias Clasp=~/clasp/src/index.js
今回はClaspのパッケージをグローバルでインストールしているので、Claspコマンドのソースコードも端末の「ユーザーごと」に入っています。
そこで、エイリアスにもユーザー用のファイルを指定します。
Windowsの場合、ソースコードの保存場所はこちら。
/C/Users/[ユーザー名]/AppData/Roaming/npm/node_modules/\@google/clasp/src/index.js
なお、これはBash用の表記で、パスはC:\Users\~
ではなく/C/Users/~
のようにバックスラッシュ/
で区切ることに注意してください。
これをコマンドに適用すると、こんな感じになります。
# aliasコマンドで「Claspコマンド」のソースを指定する alias clasp=/C/Users/[ユーザー名]/AppData/Roaming/npm/node_modules/\@google/clasp/src/index.js
ターミナル上で上記のように入力し、Enterで実行します。
しかし、これを実行してもターミナルでは特に何も出力されません。(不安…)
そこで、ちゃんと登録できたか確認する意味も込めて、改めてClaspコマンドを使ってみます。
# 入力 clasp -v # 出力(例) 2.1.0
このようにバージョンが出力されればOKです。
Googleアカウントの登録
GAS側の設定
GASのプロジェクトを外部から操作できるようにする
Google Apps Script API
を有効化します。
下記の設定ページにアクセス
背景が青い辺りにカーソルを合わせてクリック
画面右側のスイッチをクリックして、
Google Apps Script API
をオンに変更
Clasp側の設定
作業用のChromeを「アクティブ」にしておく
※ここはChromeでブラウザを複数ユーザー分作成している方向けです。
それ以外の方は次へ。
- Claspで作業したいユーザーのブラウザで任意のページを開いてウィンドウをアクティブにしておく
ClaspにGoogleアカウントを紐付ける
ターミナルに戻って下記のコマンドを入力
clasp login
自動でブラウザが開きます。
Clasp作業用のGoogleアカウントでログイン
アカウントが認証されると、ブラウザの上の方に下記のメッセージが表示されます。
Logged in! You may close this page.
ログインしました!このページは閉じて構いません。
ここまで来たら、ブラウザは一旦閉じてもOKです。
このシリーズについて
Google Apps Scriptをローカルで編集する方法について、まとめています。
誤り、分かりづらい等ありましたら、ぜひコメント欄やTwitter、お問い合わせフォーム等でご教示ください。
次回
【Clasp】ローカルでGASを書く準備 ~プロジェクトを作成する~ - ゆるおたノート
連載目次
- 【Clasp】ローカルでGASを編集するメリットとデメリット - ゆるおたノート
- 当記事【Clasp】ローカルでGASを書く準備 ~Claspをインストールする~ - ゆるおたノート
- 【Clasp】ローカルでGASを書く準備 ~プロジェクトを作成する~ - ゆるおたノート
- 【Clasp】ローカルでGASを書く準備 ~コーディングを楽にする~ - ゆるおたノート
- 【Clasp】ローカルでGASを書いてみる ~スクリプトを書いてアップロードする~ - ゆるおたノート
- 【Clasp】ローカルでGASを書いてみる ~スクリプトをGitで管理する~ - ゆるおたノート
参考
全体の手順
シェル、ターミナルの使い方
Clasp
注釈
*1: シェルとは?
シェル(英:shell)とは
コンピュータ株式会社の受付のおねーさんのこと。
もう少し真面目に書くと
人間様からの入力をコンピュータさんに伝えるプログラムのこと
です。
イメージしにくければ
Windowsにおける「コマンドプロンプト」みたいなもの
と考えても構いません。
シェル (shell)とは|「分かりそう」で「分からない」でも「分かった」気になれるIT用語辞典