コンテンツにスキップ

CLI:コンテンツタイプ

コンテンツタイプを作る、変える、削除するコマンドです。どのコマンドにも付けられる共通のフラグ(--host、--json など)は CLI のコマンドのリファレンス にあります。

スキーマ(--schema)の形は フィールドの種類と値の形 にあります。いくつものコンテンツタイプをまとめて変えるなら、スキーマのファイル を使う方が手早く確かめられます。

コマンド 内容
hakocms-cli content-types create コンテンツタイプを作る
hakocms-cli content-types delete コンテンツタイプを、中のエントリーごと削除する
hakocms-cli content-types get コンテンツタイプを取得する
hakocms-cli content-types list コンテンツタイプの一覧
hakocms-cli content-types schema set コンテンツタイプのスキーマを置き換える
hakocms-cli content-types schema versions スキーマの変更履歴
hakocms-cli content-types update コンテンツタイプの名前とコンテンツタイプ ID を変える

コンテンツタイプを作る。

ターミナルウィンドウ
hakocms-cli content-types create [OPTIONS]
フラグ・引数 説明
-s, --space <SLUG> スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順
--endpoint <TEXT> コンテンツタイプの ID(Content API のパスに入る)
--kind <TEXT> コンテンツタイプの種類。コレクションは複数のエントリー、シングルは 1 つだけのエントリーを持つ
。JSON と DB で同じ値(collection / single)を使う。選べる値:collection, single
--name <TEXT> 表示名
--schema <JSON> スキーマ
--data <JSON> 本文全体(JSON)。@file でファイル、- で標準入力から。ほかのフラグは、その上に重ねる

コンテンツタイプを、中のエントリーごと削除する。

API とそのコンテンツをすべて消す。他のコンテンツタイプから参照されている間は消せない。

ターミナルウィンドウ
hakocms-cli content-types delete [OPTIONS] <ENDPOINT>
フラグ・引数 説明
-s, --space <SLUG> スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順
<ENDPOINT> コンテンツタイプの ID
--confirm <NAME> 確かめのために、対象の名前を書く(端末でないとき)

コンテンツタイプを取得する。

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

コンテンツタイプの一覧。

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

コンテンツタイプのスキーマを置き換える。

ターミナルウィンドウ
hakocms-cli content-types schema set [OPTIONS] --type <ID>
フラグ・引数 説明
-s, --space <SLUG> スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順
-t, --type <ID> コンテンツタイプ(必須)
--allow-violations[=true|false] 既存のコンテンツが新しいスキーマに違反するとき、承知のうえで適用する
--schema <JSON> スキーマ
--schema-version <N> 編集を始めたときの版。その後に誰かが更新していたら 409 を返す
--data <JSON> 本文全体(JSON)。@file でファイル、- で標準入力から。ほかのフラグは、その上に重ねる

スキーマの変更履歴。

ターミナルウィンドウ
hakocms-cli content-types schema versions [OPTIONS] --type <ID>
フラグ・引数 説明
-s, --space <SLUG> スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順
-t, --type <ID> コンテンツタイプ(必須)

コンテンツタイプの名前とコンテンツタイプ ID を変える。

名前とエンドポイントを変える。エンドポイントを変えると Content API のパスも変わる。

ターミナルウィンドウ
hakocms-cli content-types update [OPTIONS] <ENDPOINT>
フラグ・引数 説明
-s, --space <SLUG> スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順
<ENDPOINT> コンテンツタイプの ID
--endpoint <TEXT> コンテンツタイプの ID。変えると Content API のパスも変わる
--name <TEXT> 表示名
--data <JSON> 本文全体(JSON)。@file でファイル、- で標準入力から。ほかのフラグは、その上に重ねる