Skip to content

tagru introduction ​

紹介ページ(公開ページ /i/<param>)の設定を表示・変更します。TAGRU の画面の紹介ページ設定と同じ内容を読み書きします。

text
tagru introduction show [--workspace <id> | --personal] [--target <prod|test|localhost>] [--json]
tagru introduction set <file.json> [--yes] [--workspace <id> | --personal] [--target <prod|test|localhost>] [--json]

--personal は保存済みのワークスペース選択を変えず、この要求だけ個人の設定を対象にします。--workspace との併用は通信前のエラーです。省略時は従来どおり --workspace > 接続先ごとの保存済み選択 > 個人の順です。

サブコマンド ​

サブコマンド内容
show今の設定を表示する(下書きを含む。読み取りの権限)
set <file.json>ファイルに書いた項目だけを変更し、保存後の設定を表示する(書き込みの権限)

オプション ​

オプション内容
<file.json>変更する項目と updatedAt を書いた JSON ファイル(set のみ)
--yes公開の状態(status)・公開用パラメータ(param)を変えることを了承する(set のみ。変えるときは必須)
--workspace <id>ワークスペース(tagru use で保存した値より優先)
--personal選択中のワークスペースを変えず、この要求だけ個人を対象にする(--workspace と併用不可)
-t, --target <name>接続先
--jsonJSON で出力する
  • --personal を省略した対象は --workspace > tagru use で選んだワークスペースの紹介ページです。どちらも無いときは個人の紹介ページです
  • 招待を承認していないワークスペースの紹介ページは表示・変更できません
  • set には書き込みの権限が要ります。読み取りだけでログインしているときは tagru login --write でログインし直し、同意画面で書き込みを許可してください

公開の影響 ​

公開の状態と URL

  • status を published にすると、ログインなしで公開ページ(/i/<param>)に表示されます。draft にすると表示されなくなります
  • param を変えると、古い URL はすぐに切れます。param は 1 週間に 1 回しか変えられないため、1 週間は元に戻せません。前の param は 2 週間はこの紹介ページのために残りますが、それを過ぎるとほかの人に使われることがあります
  • このため、status か param を今と違う値にするときは --yes が必要です。--yes が無いと、何が変わるかを表示して送らずに終了します(終了コード 1)

ファイルの書き方 ​

show --json の updatedAt と、変える項目だけを書きます。書かなかった項目は変わりません。

json
{
  "name": "新しい名前",
  "updatedAt": "2026-11-01T00:00:00+00:00"
}
項目型内容
updatedAtstring必須。show --json の updatedAt(まだ保存していなければ空文字)。その後に別の場所で更新されていると エラー(409) で保存しません。show からやり直してください
namestring名前(20 文字まで)
descriptionstring説明(500 文字まで)
statusstringdraft(下書き)/ published(公開)
paramstring公開用パラメータ(英数字 5〜20 文字。ほかの紹介ページと重複不可。1 週間に 1 回)
dataobject[]セクション(5 件まで)。{ "title", "link": [{ "link", "text" }] }、リンクは 1 セクション 5 件まで・URL は http:// か https://。送るとセクション全体を置き換えます
imgstring画像の URL。空文字で画像を外します。受け付けるのは、今の値と、この紹介ページ用にアップロードした画像の URL だけです(ほかの画像は imgPath で指定します)
imgPathstring画像にする素材のパス(tagru assets --json の path)。紹介ページ用に複製して img に設定します。img と同時には指定できません
  • show --json の出力をそのままファイルにしても読み込めます(item の中を使います。外枠の workspaceId は保存先を指定しないため、取得と保存に同じ --personal / --workspace を指定してください)。param が空文字(未設定)のときは送りません
  • サーバーが決める値(uid・param_changed_at・workspaceId など)や知らない項目があると、送らずにエラーになります

使い方 ​

bash
tagru introduction show                                   # 今の設定を表示する
tagru introduction show --personal --json > intro.json    # updatedAt を含めて保存する
tagru introduction set intro.json --personal              # 書いた項目だけを変える
tagru introduction set publish.json --yes                 # 公開する(status を published に)
tagru introduction show --workspace ws-xxxx

出力例 ​

text
$ tagru introduction show --workspace ws-xxxx
対象: ワークスペース ws-xxxx の紹介ページ
状態: 下書き
公開ページ: /i/sample01
名前: サンプル
説明: 説明文
画像: (なし)
セクション: 1 件
  - リンク
      公式サイト: https://example.com
updatedAt: 2026-11-01T00:00:00+00:00

set のときの先頭の行は 個人の紹介ページを保存しました。(ワークスペースは ワークスペース ws-xxxx の紹介ページを保存しました。)です。

text
$ tagru introduction set publish.json
公開の状態または URL が変わるため、確認のうえ --yes を付けて実行してください。
- status を published にします(ログインなしで公開ページに表示されます)

--json ​

--personal の外枠は workspaceId: null です。JSON の項目は変わりません。

1 件の外枠で、item は紹介ページです(set は保存後の内容)。

json
{
  "target": "prod",
  "workspaceId": null,
  "item": {
    "param": "sample01",
    "img": "",
    "name": "サンプル",
    "description": "説明文",
    "status": "draft",
    "data": [
      {
        "title": "リンク",
        "link": [{ "link": "https://example.com", "text": "公式サイト", "icon": "", "platform": "" }]
      }
    ],
    "updatedAt": "2026-11-01T00:00:00+00:00"
  }
}
項目型内容
paramstring公開用パラメータ(公開ページは /i/<param>)。未設定なら空文字
imgstring画像の URL。無ければ空文字
namestring名前
descriptionstring説明
statusstringdraft / published
dataobject[]セクション(title・link[]。リンクは link・text・icon・platform)
updatedAtstring最後に保存した日時。一度も保存していなければ空文字。set のファイルに入れる値