CLI でできること

hakocms-cli は Hako CMS をコマンドラインから操作するための道具です。スペース、コンテンツタイプ、エントリー、メディア、API キー、Webhook、メンバーなど、管理画面でできる操作をすべてコマンドで行えます。

hakocms-cli entries list --space blog --type posts

どんなときに便利か

場面	例
同じ操作をくり返す	100 件のエントリーのタグをまとめて付け直す。画像をまとめて上げる
CI から変える	サイトのリポジトリに置いたスキーマのファイルを、GitHub Actions でスペースに反映する
試しのスペースから本番のスペースへ揃える	試しのスペースで作ったコンテンツタイプを、差分を見てから本番のスペースに反映する
ほかの CMS から移る	書き出した JSON を、スクリプトでエントリーとして入れる
取り出して調べる	エントリーを JSON で取り出し、jq で絞って確かめる

1 件ずつ見ながら直すときは、管理画面の方が向いています。画面を見ながら確かめられ、プレビューもできます。

管理画面、API との関係

管理画面 ─┐
          ├─→ Admin API ─→ Hako CMS の環境
CLI ──────┘

あなたのサイト ─→ Content API（API キー）

• hakocms-cli は管理画面と同じ Admin API を使います。そのため、管理画面でできることはすべてでき、できないことはできません
• hakocms-cli はあなたとしてログインし、あなたと同じ権限で動きます。スペースのロールで許されていない操作は、管理画面と同じく断られます
• サイトにエントリーを表示するのは Content API です。Content API には API キーを使います。hakocms-cli のログインで使うアクセストークンとは別のものです

	アクセストークン（CLI）	API キー（Content API）
何として動くか	あなた（作った人と同じ権限）	スペース（キーに決めた権限）
使う API	Admin API	Content API
始まりの文字	hako_pat_	hako_
作り方	hakocms-cli auth login、または管理画面の［アクセストークン］	管理画面の［API キー］、または hakocms-cli api-keys create

手元のコンピューターで動く

hakocms-cli は手元のコンピューターや CI のマシンで動く 1 つの実行ファイルです。Linux、macOS、Windows で動きます。ほかのソフトウェアを入れる必要はありません。

ログインすると、アクセストークンは OS の資格情報の保管庫（macOS のキーチェーンなど）に入ります。いくつもの環境にログインしておき、切り替えて使えます。

操作は記録に残る

hakocms-cli で行った操作も、管理画面で行った操作と同じく、スペースの操作の記録（監査ログ）に残ります。だれが行ったかには、あなたの名前と、アクセストークンで行ったことが記録されます（操作の記録を見る）。

古い CLI と新しい Hako CMS

Hako CMS は、同じ大きい版の中では Admin API の形を変えずに、足すだけにしています。そのため、古い hakocms-cli でも新しい Hako CMS につながります。新しく足された操作は hakocms-cli を新しくすると使えます。上げ方は CLI を入れる にあります。

次に読む

• CLI を入れる
• はじめての CLI：入れてから、エントリーを 1 つ書き換えて公開するまで
• CLI のコマンドのリファレンス