CLI コマンドリファレンス

GEO Wiki Pro CLI v1.0.4 コマンドリファレンス -- 全 16 コマンドのパラメータと使い方

> GEO Wiki Pro CLI v1.0.7 は17個のコマンドを提供し、ドキュメント管理、下書き管理、カテゴリ管理、タグ管理、検索、設定、ユーザー管理などすべての機能をカバーします。 --- ## コマンド一覧 | コマンド | 説明 | ログイン必要 | |------|------|---------| | `geo login` | サーバーにログイン | いいえ | | `geo logout` | ログアウトして認証情報をクリア | いいえ | | `geo status` | 接続状態を確認 | いいえ | | `geo health` | サーバーヘルスチェック | いいえ | | `geo doc` | ドキュメント管理(CRUD + slug リネーム + 並び替え + ゴミ箱) | はい | | `geo category` | カテゴリ管理(CRUD + 並び替え) | はい | | `geo tag` | タグ管理(作成/一覧/削除) | はい | | `geo search` | ドキュメント検索 | いいえ | | `geo config` | サイト設定の読み書き | はい | | `geo user` | ユーザー管理 + Token 管理 | はい | | `geo draft` | 下書き管理(一覧/表示/公開/削除) | はい | | `geo stats` | ダッシュボード統計データ | はい | | `geo feedback` | ユーザーフィードバック管理 | はい | | `geo guestbook` | ゲストブック管理 | はい | | `geo media` | メディアファイルのアップロード/一覧/削除 | はい | | `geo geo` | GEO ステータス、レポート、再構築 | はい | --- ## 認証コマンド ### geo login GEO Wiki Pro サーバーにログインします。API Token 認証を使用し、有効期間は90日です。 ```bash geo login --url https://geowiki.pro --token geo_xxxxx ``` | パラメータ | 短縮形 | 説明 | 必須 | |------|------|------|------| | `--url` | `-u` | サーバーアドレス | はい | | `--token` | `-t` | API Token | はい | > Token は管理パネルの「設定 -> API Token」で生成します。 ### geo logout ローカルに保存された認証情報をクリアします。 ```bash geo logout ``` ### geo status 現在の接続状態とユーザー情報を確認します。 ```bash geo status ``` ### geo health サーバーのヘルス状態をチェックします。認証不要です。デプロイ検証や監視スクリプトに適しています。 ```bash geo health geo health --json ``` 出力例: ``` ✅ Server is healthy URL: https://geowiki.pro Status: 200 OK ``` --- ## ドキュメントコマンド ### geo doc list すべてのドキュメントを一覧表示します。 ```bash geo doc list geo doc list --category can-motion geo doc list --lang zh --json ``` | パラメータ | 短縮形 | 説明 | 必須 | |------|------|------|------| | `--category` | | カテゴリでフィルタ | いいえ | | `--lang` | `-l` | 言語(必須:zh/en/jp) | はい | | `--page` | | ページ番号(デフォルト 1) | いいえ | | `--limit` | | 1ページあたりの件数(デフォルト 50) | いいえ | ### geo doc get ドキュメントの内容を取得します。 ```bash geo doc get --slug quick-start geo doc get --slug quick-start --lang en geo doc get --slug quick-start --format json ``` | パラメータ | 短縮形 | 説明 | 必須 | |------|------|------|------| | `--slug` | `-s` | ドキュメント slug | はい | | `--lang` | `-l` | 言語(デフォルト zh) | いいえ | | `--format` | `-f` | 出力形式:markdown または json | いいえ | ### geo doc create 新しいドキュメントを作成します。 ```bash # ファイルから作成 geo doc create --file ./my-doc.md --category can-motion --lang zh # 直接内容を渡して作成 geo doc create --title "タイトル" --category docs --slug my-doc --content "# 本文コンテンツ" # 下書きとして保存 geo doc create --file ./my-doc.md --category guide --draft ``` | パラメータ | 短縮形 | 説明 | 必須 | |------|------|------|------| | `--file` | `-f` | Markdown ファイルパス | はい(または --title) | | `--title` | `-t` | ドキュメントタイトル(ファイルなしの場合) | はい(または --file) | | `--content` | | インラインコンテンツ(ファイル不要) | いいえ | | `--category` | `-c` | カテゴリ slug | いいえ | | `--slug` | `-s` | カスタム slug | いいえ | | `--lang` | `-l` | 言語コード(必須:zh/en/jp) | はい | | `--tags` | `-T` | カンマ区切りのタグ | いいえ | | `--author` | `-a` | 著者(デフォルト Agent) | いいえ | | `--sort` | | 並び順値(デフォルト 999) | いいえ | | `--draft` | | 下書きとして保存(直接公開しない) | いいえ | ::: tip ファイルには YAML frontmatter(title、slug、category、tags、author)を含める必要があります。ファイルに frontmatter が含まれている場合、コマンドラインパラメータは省略でき、CLI が自動的に抽出します。 ::: ### geo doc update ドキュメントを更新します。単一フィールド更新をサポートし、指定したフィールドのみを変更し、他のフィールドは保持します。 ```bash # ファイル更新(最も安全) geo doc update --slug my-doc --file ./updated.md # タイトル更新 geo doc update --slug my-doc --title "新タイトル" --lang zh # 説明更新 geo doc update --slug my-doc --description "新説明" --lang zh # 著者更新 geo doc update --slug my-doc --author "張三" --lang zh # タグ更新 geo doc update --slug my-doc --tags "tag1,tag2" --lang zh # 通知更新 geo doc update --slug my-doc --notice "このドキュメントは更新されました" --lang zh # 並び順値のみ更新 geo doc update --slug my-doc --sort 0 # カテゴリのみ更新 geo doc update --slug my-doc --category new-category # コンテンツのみ更新 geo doc update --slug my-doc --content "# 新タイトル\n\n新コンテンツ" # 下書きとして保存 geo doc update --slug my-doc --file ./updated.md --draft ``` | パラメータ | 短縮形 | 説明 | 必須 | |------|------|------|------| | `--slug` | `-s` | ドキュメント slug | はい | | `--file` | `-f` | 更新後のファイルパス | はい(いずれか) | | `--content` | | インラインコンテンツ | はい(いずれか) | | `--title` | `-t` | タイトル更新 | いいえ | | `--description` | `-d` | 説明更新 | いいえ | | `--author` | `-a` | 著者更新 | いいえ | | `--tags` | `-T` | タグ更新(カンマ区切り) | いいえ | | `--notice` | | 通知更新 | いいえ | | `--category` | `-c` | 新しいカテゴリ | いいえ | | `--sort` | | 新しい並び順値 | いいえ | | `--lang` | `-l` | 言語コード | いいえ | | `--draft` | | 下書きとして保存 | いいえ | ::: note 単一フィールド更新は指定したフィールドのみを変更し、他のフィールドは元の値を保持します。 ::: ### geo doc delete ドキュメントを削除します(ゴミ箱に移動し、30日後に自動削除)。 ```bash geo doc delete --slug my-doc geo doc delete --slug my-doc --yes # 確認をスキップ ``` | パラメータ | 短縮形 | 説明 | 必須 | |------|------|------|------| | `--slug` | `-s` | ドキュメント slug | はい | | `--lang` | `-l` | 言語コード | いいえ | | `--yes` | `-y` | 確認プロンプトをスキップ | いいえ | ### geo doc slug-rename ドキュメントの URL slug をリネームします。すべての言語バージョン(zh/en/jp)は同じ slug を共有し、リネームは全言語バージョンを同期更新します。タイトルやコンテンツなどのフィールドは影響を受けません。 ```bash geo doc slug-rename --slug old-name --new-slug new-name geo doc slug-rename --slug my-doc --new-slug my-document --json ``` | パラメータ | 短縮形 | 説明 | 必須 | |------|------|------|------| | `--slug` | `-s` | 現在のドキュメント slug | はい | | `--new-slug` | | 新しい slug | はい | ::: warning slug の変更によりドキュメントの URL が変わります。他のドキュメントが旧 slug にリンクしている場合は、手動で更新が必要です。 ::: ### geo doc trash / recover ゴミ箱のドキュメントを表示・復元します。 ```bash geo doc trash # ゴミ箱を一覧表示 geo doc trash --clear # ゴミ箱を空にする geo doc recover --file my-doc-zh-123456.md # ドキュメントを復元 ``` ### geo doc reorder ドキュメントの並び順を一括調整します。 ```bash geo doc reorder --orders "quick-start:0,faq:1,architecture:2" ``` | パラメータ | 短縮形 | 説明 | 必須 | |------|------|------|------| | `--orders` | `-o` | 形式:`slug1:並び順値,slug2:並び順値` | はい | --- ## カテゴリコマンド ### geo category list すべてのカテゴリを一覧表示します。 ```bash geo category list geo category list --json ``` ### geo category create カテゴリを作成します。 ```bash geo category create --name "CAN モーター" --name-en "CAN MOTION" --slug can-motion ``` | パラメータ | 説明 | 必須 | |------|------|------| | `--name` | カテゴリ名(デフォルト言語) | はい | | `--name-en` | 英語名 | いいえ | | `--name-jp` | 日本語名 | いいえ | | `--slug` | カテゴリ slug | はい | ### geo category update カテゴリ情報を更新します。 ```bash geo category update --slug can-motion --name "新名称" --name-en "New Name" ``` ### geo category reorder カテゴリの並び順を一括調整します。 ```bash geo category reorder --orders "products:0,technical:1,support:2" ``` ### geo category delete カテゴリを削除します。 ```bash geo category delete --slug old-category ``` --- ## タグコマンド ### geo tag list / create / delete ```bash geo tag list geo tag list --json geo tag create --name "CAN Bus" --slug can-bus geo tag delete --slug can-bus ``` | パラメータ | 短縮形 | 説明 | 必須 | |------|------|------|------| | `--slug` | `-s` | タグ slug | はい | | `--name` | `-n` | タグ表示名 | はい(create) | --- ## 検索コマンド ### geo search ドキュメントを検索します。 ```bash geo search "CAN bus" --lang zh geo search "motor" --category can-motion --lang zh geo search "Arduino" --lang en --json ``` | パラメータ | 短縮形 | 説明 | 必須 | |------|------|------|------| | `--category` | `-c` | カテゴリでフィルタ | いいえ | | `--lang` | `-l` | 言語(必須:zh/en/jp) | はい | | `--limit` | | 最大結果数(デフォルト 20) | いいえ | --- ## 設定コマンド ### geo config get サイト設定を取得します。 ```bash geo config get geo config get --json ``` ### geo config update サイト設定を更新します。 ```bash geo config update --site-name "私の知識ベース" geo config update --hero-title-zh "ようこそ" --hero-title-en "Welcome" geo config update --hero-subtitle-zh "製品ドキュメント" --hero-subtitle-en "Product docs" geo config update --featured-slugs "quick-start,faq,overview" geo config update --logo-url "/media/logo.png" --favicon-url "/media/favicon.ico" geo config update --custom-head '<meta name="theme-color" content="#2563EB">' ``` | パラメータ | 説明 | 必須 | |------|------|------| | `--site-name` | サイト名 | いいえ | | `--site-desc` | サイト説明(SEO) | いいえ | | `--default-lang` | デフォルト言語(zh, en, jp) | いいえ | | `--hero-title` | Hero エリアのタイトル | いいえ | | `--hero-title-zh` | Hero タイトル(中国語) | いいえ | | `--hero-title-en` | Hero タイトル(英語) | いいえ | | `--hero-title-jp` | Hero タイトル(日本語) | いいえ | | `--hero-subtitle` | Hero サブタイトル | いいえ | | `--hero-subtitle-zh` | Hero サブタイトル(中国語) | いいえ | | `--hero-subtitle-en` | Hero サブタイトル(英語) | いいえ | | `--hero-subtitle-jp` | Hero サブタイトル(日本語) | いいえ | | `--featured-slugs` | カンマ区切りの推奨ドキュメント slug | いいえ | | `--logo-url` | Logo 画像パス | いいえ | | `--favicon-url` | Favicon パス | いいえ | | `--custom-head` | カスタム HTML(`<head>` に注入) | いいえ | --- ## ユーザーコマンド ### geo user list / create / update / delete ```bash geo user list geo user list --json geo user create --username editor1 --password MyPass123 --role editor geo user update --id user-xxx --role admin geo user reset-password --id user-xxx geo user delete --id user-xxx ``` | パラメータ | 説明 | 必須 | |------|------|------| | `--id` | ユーザー ID(update/delete/reset-password に必須) | はい | | `--username` | ユーザー名(create に必須) | はい | | `--password` | パスワード(create に必須) | はい | | `--role` | ロール:admin / editor / viewer(デフォルト editor) | いいえ | ### geo user token API Token を管理します。 ```bash geo user token list # すべての Token を一覧表示 geo user token list --json # JSON 形式出力 geo user token delete --id token-id # Token を無効化 ``` ::: note API Token の作成は管理パネルの「設定 -> API Token」でのみ行えます。 ::: --- ## 下書きコマンド ```bash geo draft list # すべての下書きを一覧表示 geo draft list --json # JSON 形式出力 geo draft get --slug my-draft # 下書き内容を表示 geo draft publish --slug my-draft # 下書きを公開 geo draft publish --slug my-draft --lang en # 下書きを公開(言語指定) geo draft delete --slug my-draft # 下書きを削除 geo draft delete --slug my-draft --lang en # 下書きを削除(言語指定) ``` | パラメータ | 短縮形 | 説明 | 必須 | |------|------|------|------| | `--slug` | `-s` | 下書き slug | はい | | `--lang` | `-l` | 言語コード | いいえ | | `--json` | | JSON 形式出力 | いいえ | --- ## 統計コマンド ```bash geo stats # ダッシュボード統計を表示 geo stats metrics # 詳細システム指標を表示 geo stats --json # JSON 形式出力 ``` --- ## フィードバックコマンド ```bash geo feedback list # すべてのフィードバックを一覧表示 geo feedback list --json # JSON 形式出力 geo feedback delete --id "feedback-id" # フィードバックを削除 geo feedback promote --id "feedback-id" # フィードバックをドキュメントコンテンツまたは FAQ に昇格 ``` --- ## ゲストブックコマンド ```bash geo guestbook list # すべてのメッセージを一覧表示 geo guestbook list --json # JSON 形式出力 geo guestbook toggle --enabled true # ゲストブックを有効化 geo guestbook toggle --enabled false # ゲストブックを無効化 geo guestbook update --id "entry-id" --status approved # 承認 geo guestbook update --id "entry-id" --status rejected # 拒否 geo guestbook delete --id "entry-id" # メッセージを削除 ``` --- ## メディアコマンド ```bash geo media upload --file ./diagram.png geo media upload --file ./manual.pdf --directory docs geo media upload --file ./model.step --directory models geo media list --json geo media delete --file old-image.jpg ``` | パラメータ | 短縮形 | 説明 | 必須 | |------|------|------|------| | `--file` | `-f` | ローカルファイルパス(アップロード)またはファイル名(削除) | はい | | `--directory` | `-d` | public/media 配下のサブディレクトリ | いいえ | ### サポートされているファイルタイプ | タイプ | フォーマット | |------|------| | 画像 | JPG, PNG, GIF, WebP | | 動画 | MP4, WebM | | 音声 | MP3, WAV, OGG | | ドキュメント | PDF, DOC, DOCX, TXT, MD | | 3D モデル | STEP, STP, IGS | --- ## GEO コマンド ### geo geo status GEO 最適化ステータスを確認します。 ```bash geo geo status ``` ### geo geo rebuild GEO ファイル(llms.txt、sitemap.xml)を再構築します。 ```bash geo geo rebuild ``` ### geo geo report GEO 分析レポートを表示します。 ```bash geo geo report geo geo report --json ``` ### geo geo llms / sitemap / manifest ```bash geo geo llms # llms.txt の内容を表示 geo geo sitemap # sitemap.xml の内容を表示 geo geo manifest # サイト manifest を表示 ``` --- ## グローバルオプション すべてのコマンドは `--json` フラグをサポートし、マシンリーダブルな JSON 形式で出力します。Agent のパースに適しています。 --- ## 関連ドキュメント - [CLI インストールとログイン](/docs/cli-install) -- インストールとログインガイド - [CLI クイックリファレンス](/docs/cli-quick-reference) -- Agent クイック使用マニュアル - [GEO Wiki Pro ユーザーマニュアル](/docs/geo-wiki-pro-user-manual) -- 完全なユーザーマニュアル - [REST API ドキュメント](/docs/rest-api) -- API エンドポイントリファレンス