claat のセットアップ方法 (Windows 11 & macOS Monterey)



本記事では Windows と macOS への claat (Google Codelabs command line tool) の実行可能ファイルのセットアップ方法について記載する。両 OS ともに実行可能ファイルをダウンロードしてパスを通す手順について簡単に解説する。なお、Go 言語を使った方法については本記事では取り扱わない。

Windows での claat のセットアップ方法

Windows のバージョンは以下の通り

  • Microsoft Windows 11 Enterprise
  • 10.0.22621 ビルド 22621
  • Surface Book 2

最新版の claat の実行可能モジュールをダウンロード

以下パスから最新バージョンを選択、Windows 用の実行可能モジュール (claat-windows-amd64.exe) をダウンロードして任意のディレクトリに格納

ファイル名をリネーム & パスを通す

  • ファイル名を claat-windows-amd64.exe から claat.exe に変更する
  • コントロール パネル > システムとセキュリティ > システム > システムの詳細設定 > 環境変数にアクセスし、システムの環境変数 > Path に claat.exe を格納したフォルダを追加する

claat コマンドを実行

コマンド プロンプトや PowerShell を開き、claat コマンドが実行できることを確認する

> claat -h
Usage: claat <cmd> [options] src [src ...]

Available commands are: export, serve, update, version.


## Flags

  -addr string
        hostname and port to bind web server to (default "localhost:9090")
  -auth string
        OAuth2 Bearer token; alternative credentials override.
  -e string
        codelab environment (default "web")
  -extra string
        Additional arguments to pass to format templates. JSON object of string,string key values.
  -f string
        output format (default "html")
  -ga string
        global Google Analytics account (default "UA-49880327-14")
  -md_parser string
        Markdown parser to use. Accepted values: "blackfriday", "goldmark" (default "blackfriday")
  -o string
        output directory or '-' for stdout (default ".")
  -pass_metadata string
        Metadata fields to pass through to the output. Comma-delimited list of field names.
  -prefix string
        URL prefix for html format (default "https://storage.googleapis.com")

Windows でのセットアップ手順は以上

macOS での claat のセットアップ

macOS のバージョンは以下の通り

  • macOS Monterey バージョン 12.6
  • MacBook Pro (13-inch, M1, 2020)
  • チップ Apple M1

最新版の claat の実行可能ファイルをダウンロード

以下パスから最新バージョンを選択、macOS 用の実行可能ファイル (claat-darwin-amd64) をダウンロードして任意のディレクトリに格納

claat にエイリアスを設定

$ vi ~/.zprofile

# 末尾に以下を追記 (パスは自身の環境に合わせて書き換え)
alias claat="/path/to/claat-darwin-amd64"

claat コマンドを実行

$ source ~/.zprofile
$ claat -h
Usage: claat <cmd> [options] src [src ...]

Available commands are: export, serve, update, version.

## Export command

Export takes one or more 'src' documents and converts them
to the format specified with -f option.

macOS でのセットアップ手順は以上

Visual Studio Code での編集を楽にする方法

Markdown ファイル保存時に自動的に claat export が実行されるようにしておくと編集が楽になる

    "emeraldwalk.runonsave": {
        "commands": [
                "match": "\\.md$",
                "cmd": "claat export workshop.md"