CLI:エントリー
エントリーを作る、変える、公開する、削除するコマンドと、版の履歴、予約公開のコマンドです。どのコマンドにも付けられる共通のフラグ(--host、--json など)は CLI のコマンドのリファレンス にあります。
使い方は エントリーをまとめて書き換える・取り出す にあります。値(--data、--set)の形は フィールドの種類と値の形 と リッチテキストの形 にあります。
| コマンド | 内容 |
|---|---|
hakocms-cli entries create |
エントリーを作る(下書き、または公開) |
hakocms-cli entries delete |
エントリーを削除する |
hakocms-cli entries discard-draft |
下書きを捨てて、公開版に戻す |
hakocms-cli entries edit |
エントリーの値(下書き、なければ公開版)を JSON のファイルにして、$VISUAL か $EDITOR で開く |
hakocms-cli entries get |
エントリーを取得する |
hakocms-cli entries list |
エントリーの一覧 |
hakocms-cli entries publish |
エントリーを公開する |
hakocms-cli entries revisions get |
版を 1 つ、値ごと取得する |
hakocms-cli entries revisions list |
エントリーの版の一覧(値は含めない) |
hakocms-cli entries schedule |
予約公開と予約公開終了を設定する。キーを省略したものは変えず、null で取り消す |
hakocms-cli entries unpublish |
公開を終了する。下書きは残る |
hakocms-cli entries update |
エントリーの値を変えて、下書きに保存する(管理画面の「保存」と同じ) |
hakocms-cli entries create
Section titled “hakocms-cli entries create”エントリーを作る(下書き、または公開)
hakocms-cli entries create [OPTIONS] --type <ID>| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
-t, --type <ID> |
コンテンツタイプ(必須) |
--id <TEXT> |
省略すると自動で採番する |
--publish[=true|false] |
true ならすぐ公開する。false(既定)なら下書きとして作る |
--data <JSON> |
エントリーの値(JSON)。@file でファイル、- で標準入力から |
--set <FIELD=VALUE> |
項目の値。値は JSON として読めればその値、読めなければ文字列(–set count=3 は数、–set title=hello は文字列) |
hakocms-cli entries delete
Section titled “hakocms-cli entries delete”エントリーを削除する。
hakocms-cli entries delete [OPTIONS] --type <ID> <ID>| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
-t, --type <ID> |
コンテンツタイプ(必須) |
<ID> |
ID |
--force |
確かめずに行う |
hakocms-cli entries discard-draft
Section titled “hakocms-cli entries discard-draft”下書きを捨てて、公開版に戻す。
hakocms-cli entries discard-draft [OPTIONS] --type <ID> <ID>| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
-t, --type <ID> |
コンテンツタイプ(必須) |
<ID> |
ID |
--force |
確かめずに行う |
hakocms-cli entries edit
Section titled “hakocms-cli entries edit”エントリーの値(下書き、なければ公開版)を JSON のファイルにして、$VISUAL か $EDITOR で開く。
保存して閉じると、下書きに保存する(変えなければ何もしない)。–publish なら、その値で公開する。
hakocms-cli entries edit [OPTIONS] <ID> --type <ID>| フラグ・引数 | 説明 |
|---|---|
<ID> |
エントリーの ID |
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
-t, --type <ID> |
コンテンツタイプ(必須) |
--publish |
下書きにせず、公開する |
hakocms-cli entries get
Section titled “hakocms-cli entries get”エントリーを取得する。
hakocms-cli entries get [OPTIONS] --type <ID> <ID>| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
-t, --type <ID> |
コンテンツタイプ(必須) |
<ID> |
ID |
hakocms-cli entries list
Section titled “hakocms-cli entries list”エントリーの一覧。
hakocms-cli entries list [OPTIONS] --type <ID>| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
-t, --type <ID> |
コンテンツタイプ(必須) |
--query <TEXT> |
全文検索 |
--status <TEXT> |
published draft closed reserved をカンマ区切りで(どれかに当てはまるもの) |
--orders <TEXT> |
updatedAt publishedAt createdAt。先頭に - で降順 |
--limit <N> |
出す件数(既定 30) |
--all |
全部のページをたどる |
hakocms-cli entries publish
Section titled “hakocms-cli entries publish”エントリーを公開する。
hakocms-cli entries publish [OPTIONS] --type <ID> <ID>| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
-t, --type <ID> |
コンテンツタイプ(必須) |
<ID> |
ID |
--data <JSON> |
エントリーの値(JSON)。@file でファイル、- で標準入力から |
--set <FIELD=VALUE> |
項目の値。値は JSON として読めればその値、読めなければ文字列(–set count=3 は数、–set title=hello は文字列) |
hakocms-cli entries revisions get
Section titled “hakocms-cli entries revisions get”版を 1 つ、値ごと取得する。
1 版を値ごと(比較と、編集画面への読み込みに使う)
hakocms-cli entries revisions get [OPTIONS] --type <ID> --entry <TEXT> <REVISION_ID>| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
-t, --type <ID> |
コンテンツタイプ(必須) |
--entry <TEXT> |
ID(必須) |
<REVISION_ID> |
版の ID |
hakocms-cli entries revisions list
Section titled “hakocms-cli entries revisions list”エントリーの版の一覧(値は含めない)
版の一覧(値を含めない)。cursor は前のページの最後の版の番号。
hakocms-cli entries revisions list [OPTIONS] --type <ID> --entry <TEXT>| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
-t, --type <ID> |
コンテンツタイプ(必須) |
--entry <TEXT> |
ID(必須) |
--limit <N> |
出す件数(既定 30) |
--all |
全部のページをたどる |
hakocms-cli entries schedule
Section titled “hakocms-cli entries schedule”予約公開と予約公開終了を設定する。キーを省略したものは変えず、null で取り消す。
hakocms-cli entries schedule [OPTIONS] --type <ID> <ID>| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
-t, --type <ID> |
コンテンツタイプ(必須) |
<ID> |
ID |
--close-at <TEXT> |
予約公開終了の日時(RFC 3339)。null で取り消す。省くと変えない |
--publish-at <TEXT> |
予約公開の日時(RFC 3339)。null で取り消す。省くと変えない |
--data <JSON> |
本文全体(JSON)。@file でファイル、- で標準入力から。ほかのフラグは、その上に重ねる |
hakocms-cli entries unpublish
Section titled “hakocms-cli entries unpublish”公開を終了する。下書きは残る。
hakocms-cli entries unpublish [OPTIONS] --type <ID> <ID>| フラグ・引数 | 説明 |
|---|---|
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
-t, --type <ID> |
コンテンツタイプ(必須) |
<ID> |
ID |
hakocms-cli entries update
Section titled “hakocms-cli entries update”エントリーの値を変えて、下書きに保存する(管理画面の「保存」と同じ)。
今の値(下書き、なければ公開版)に –set の項目を重ねる。–data を渡すと、今の値の代わりにそれを使う。–publish を付けると、下書きにせず、その値で公開する。
hakocms-cli entries update [OPTIONS] <ID> --type <ID>| フラグ・引数 | 説明 |
|---|---|
<ID> |
エントリーの ID |
-s, --space <SLUG> |
スペース。省くと HAKOCMS_SPACE、hakocms-cli.toml、spaces use で決めたものの順 |
-t, --type <ID> |
コンテンツタイプ(必須) |
--data <JSON> |
エントリーの値全体(JSON)。@file でファイル、- で標準入力から |
--set <FIELD=VALUE> |
項目の値。値は JSON として読めればその値、読めなければ文字列(–set count=3 は数、–set title=hello は文字列) |
--publish |
下書きにせず、公開する |