コンテンツにスキップ

CLI のコマンドのリファレンス

hakocms-cli のすべてのコマンドと、フラグ・引数の一覧です。入れ方とログインは CLI を入れる と CLI でログインする、出力の形と終了コードは CLI の出力と終了コード にあります。

コマンドは hakocms-cli <資源> <操作> の形です(hakocms-cli entries list)。どのコマンドも --help で、このページと同じ説明が出ます。

どのコマンドにも付けられます。

フラグ・引数 説明
--host <URL|NAME> つなぐサーバー(URL か、auth login で付けた名前)。省くと HAKOCMS_HOST、hakocms-cli.toml、auth switch の順
--json JSON で出す
--jq <EXPR> JSON を jq の式で絞る(–json を含む)
--no-input 何も聞かない。聞く必要があれば誤りにする
コマンド 内容 コマンドの数
ログインとアクセストークン Hako CMS へのログイン、ログアウト、つなぐ先の切り替えと、アクセストークンの一覧・取り消しのコマンドです。 7
スペース スペースを作る、一覧にする、削除するコマンドと、--space を省いたときのスペースを決めるコマンドです。 5
コンテンツタイプ コンテンツタイプを作る、変える、削除するコマンドです。 7
エントリー エントリーを作る、変える、公開する、削除するコマンドと、版の履歴、予約公開のコマンドです。 12
メディア メディアを上げる、一覧にする、変える、削除するコマンドです。 6
スキーマのファイル スペースのスキーマを .hako.json のファイルとして取り出し、差分を見て、ほかのスペースに反映するコマンドと、型の定義を取り出すコマンドです。 4
スキーマの反映 スキーマのファイルの反映(ジョブ)を始める、進み具合を見る、結果を取り出すコマンドです。ふつうは schema apply を使います。 5
書き出し スペースのエントリーとメディアを、ファイルに書き出すコマンドです。 5
取り込み 書き出したファイルから、スペースを作るコマンドです。 7
API キー Content API で使う API キーを発行する、権限を変える、失効させるコマンドです。 5
Webhook Webhook を作る、変える、削除するコマンドと、送った記録を見る、送り直すコマンドです。 8
メンバー スペースのメンバーを一覧にする、ロールを変える、外すコマンドです。 4
招待 スペースへの招待を作る、一覧にする、取り消すコマンドです。 5
ロール スペースのロール(できる操作の組み合わせ)を作る、変える、削除するコマンドです。 5
ユーザー 環境のユーザーを作る、一覧にする、削除するコマンドと、パスワードを決めるリンクを発行するコマンドです。多くは環境の管理者だけが使えます。 5
操作の記録 スペースの操作の記録(監査ログ)を見る、CSV で書き出すコマンドです。 2
使用量 スペースと環境全体の、今の使用量と上限を見るコマンドです。 1
Admin API を直接呼ぶ コマンドのない操作のために、任意の Admin API を呼ぶコマンドです。 1
シェルの補完 シェルでコマンドやフラグを補完するためのスクリプトを出すコマンドです。 1
版 hakocms-cli の版と、話す Admin API の版を出すコマンドです。 1