CLI：スキーマのファイル

スペースのスキーマを .hako.json のファイルとして取り出し、差分を見て、ほかのスペースに反映するコマンドと、型の定義を取り出すコマンドです。どのコマンドにも付けられる共通のフラグ（--host、--json など）は CLI のコマンドのリファレンス にあります。

使い方は CI でスキーマを反映する にあります。

コマンド	内容
hakocms-cli schema apply	スキーマのファイルを、スペースに反映する
hakocms-cli schema diff	スキーマのファイルと、スペースの今のスキーマの差分を出す（何も変えない）
hakocms-cli schema pull	スペースのスキーマを、スキーマのファイル（.hako.json）に取り出す
hakocms-cli schema types	エントリーの型（TypeScript）、GraphQL のスキーマ、公開 API の OpenAPI を書き出す

hakocms-cli schema apply

スキーマのファイルを、スペースに反映する。

差分を出して見せ、確かめてから反映し、終わるまで待つ。CI から使うときは –force。今のエントリーが合わない変更は –allow-violations、ファイルにないコンテンツタイプを消すには –prune が要る。

hakocms-cli schema apply [OPTIONS] <FILE>

フラグ・引数	説明
<FILE>	スキーマのファイル（- で標準入力）
-s, --space <SLUG>	スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順
--allow-violations	今のエントリーが違反する変更も反映する
--prune	ファイルにないコンテンツタイプを、エントリーごと消す
--force	確かめずに反映する

hakocms-cli schema diff

スキーマのファイルと、スペースの今のスキーマの差分を出す（何も変えない）

hakocms-cli schema diff [OPTIONS] <FILE>

フラグ・引数	説明
<FILE>	スキーマのファイル（- で標準入力）
-s, --space <SLUG>	スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順

hakocms-cli schema pull

スペースのスキーマを、スキーマのファイル（.hako.json）に取り出す。

そのままスキーマの反映に送れる。

hakocms-cli schema pull [OPTIONS]

フラグ・引数	説明
-s, --space <SLUG>	スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順
-o, --output <PATH>	書き出す先（- で標準出力）。省くと <スラッグ>.hako.json
--force	ファイルがあれば上書きする

hakocms-cli schema types

エントリーの型（TypeScript）、GraphQL のスキーマ、公開 API の OpenAPI を書き出す。

hakocms-cli schema types [OPTIONS]

フラグ・引数	説明
-s, --space <SLUG>	スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順
--format <FORMAT>	形（既定 typescript）
-o, --output <PATH>	書き出す先（- で標準出力）。省くと標準出力
--force	ファイルがあれば上書きする