コンテンツにスキップ

CLI:スキーマの反映

スキーマのファイルの反映(ジョブ)を始める、進み具合を見る、結果を取り出すコマンドです。ふつうは schema apply を使います。どのコマンドにも付けられる共通のフラグ(--host、--json など)は CLI のコマンドのリファレンス にあります。

コマンド 内容
hakocms-cli schema-applies create スキーマのファイル(*.hako.json)を送り、今のスペースとの差分を出す。まだ何も変えない
hakocms-cli schema-applies delete 反映の記録を消す。待っているか動いているものは消せない(409)
hakocms-cli schema-applies get スキーマの反映を 1 件取得する
hakocms-cli schema-applies list スキーマの反映(新しい順に 20 件)
hakocms-cli schema-applies start 差分を確かめたうえで、スキーマの反映を始める

スキーマのファイル(*.hako.json)を送り、今のスペースとの差分を出す。まだ何も変えない。

–wait で差分が出るまで待って見せる。同意したら schema-applies start で反映する。

ターミナルウィンドウ
hakocms-cli schema-applies create [OPTIONS] <FILE>
フラグ・引数 説明
<FILE> スキーマのファイル(- で標準入力)
-s, --space <SLUG> スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順
--wait ジョブが終わるまで待ち、結果を出す。失敗したら 1 で終わる

反映の記録を消す。待っているか動いているものは消せない(409)

ターミナルウィンドウ
hakocms-cli schema-applies delete [OPTIONS] <ID>
フラグ・引数 説明
-s, --space <SLUG> スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順
<ID> ID
--force 確かめずに行う

スキーマの反映を 1 件取得する。

ターミナルウィンドウ
hakocms-cli schema-applies get [OPTIONS] <ID>
フラグ・引数 説明
-s, --space <SLUG> スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順
<ID> ID

スキーマの反映(新しい順に 20 件)

ターミナルウィンドウ
hakocms-cli schema-applies list [OPTIONS]
フラグ・引数 説明
-s, --space <SLUG> スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順

差分を確かめたうえで、スキーマの反映を始める。

差分に同意して反映を始める。同意で足りなければ 409(理由を 1 行に 1 つ)

ターミナルウィンドウ
hakocms-cli schema-applies start [OPTIONS] <ID>
フラグ・引数 説明
-s, --space <SLUG> スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順
<ID> ID
--allow-violations[=true|false] 今のエントリーが違反する変更も反映する。省くと false
--prune[=true|false] 消える(delete の)コンテンツタイプを、エントリーごと消す。省くと false
--data <JSON> 本文全体(JSON)。@file でファイル、- で標準入力から。ほかのフラグは、その上に重ねる
--wait ジョブが終わるまで待ち、結果を出す。失敗したら 1 で終わる