@aigne/doc-smith 0.8.11-beta.5 → 0.8.11-beta.7

package/docs/cli-reference.ja.md

@@ -1,193 +1,261 @@
 # CLIコマンドリファレンス
 
-このガイドでは、利用可能なすべての `aigne doc` サブコマンド、その引数、およびオプションのリファレンスを提供します。コマンドラインインターフェースを最大限に活用したいユーザーを対象としています。
+このガイドは、利用可能なすべての`aigne doc`サブコマンド、その引数、およびオプションに関する包括的なリファレンスを提供します。コマンドラインインターフェースを最大限に活用したいユーザーを対象としています。
 
-一般的な構文は次のとおりです。
+一般的な構文は次のとおりです：
 
-```bash
+```bash command icon=lucide:terminal
 aigne doc <command> [options]
 ```
 
 ### コマンドのワークフロー
 
-以下の図は、DocSmithのCLIコマンドを使用してドキュメントを作成および保守する典型的なライフサイクルを示しています。
+以下の図は、DocSmithのCLIコマンドを使用してドキュメントを作成および維持する一般的なライフサイクルと、それらが相互作用するデータを示しています。
 
 ```d2
 direction: down
 
-Start: {
-  label: "プロジェクトのセットアップ"
-  shape: circle
+# Artifacts
+Source-Code: {
+  label: "ソースコード"
+  shape: cylinder
 }
-
-init: {
-  label: "aigne doc init\n(対話式セットアップ)"
-  shape: rectangle
+Configuration: {
+  label: "設定\n(.aigne/doc-smith/config.yml)"
+  shape: cylinder
 }
-
-generate: {
-  label: "aigne doc generate\n(全ドキュメントの作成/更新)"
-  shape: rectangle
+Generated-Docs: {
+  label: "生成されたドキュメント"
+  shape: cylinder
+}
+Published-Docs: {
+  label: "公開されたサイト"
+  shape: cylinder
 }
 
-refinement-cycle: {
-  label: "改良サイクル"
-  shape: rectangle
-  grid-columns: 2
+# --- Core Workflow ---
+Lifecycle: {
+  label: "ドキュメントのライフサイクル"
+  
+  init: {
+    label: "1. 初期化\n`aigne doc init`"
+    shape: rectangle
+  }
+
+  generate: {
+    label: "2. 生成\n`aigne doc generate`"
+    shape: rectangle
+  }
 
-  update: {
-    label: "aigne doc update\n(単一ドキュメントの改良)"
+  Refinement: {
+    label: "3. 改良 (反復)"
+    grid-columns: 2
+
+    update: {
+      label: "更新\n`aigne doc update`"
+      shape: rectangle
+    }
+    translate: {
+      label: "翻訳\n`aigne doc translate`"
+      shape: rectangle
+    }
   }
-  translate: {
-    label: "aigne doc translate\n(コンテンツのローカライズ)"
+
+  publish: {
+    label: "4. 公開\n`aigne doc publish`"
+    shape: rectangle
   }
 }
 
-publish: {
-  label: "aigne doc publish\n(ドキュメントのデプロイ)"
-  shape: rectangle
+# --- Utility Commands ---
+Utilities: {
+  label: "ユーティリティコマンド"
+  grid-columns: 2
+  
+  prefs: {
+    label: "設定管理\n`aigne doc prefs`"
+    shape: rectangle
+  }
+  clear: {
+    label: "データ消去\n`aigne doc clear`"
+    shape: rectangle
+  }
 }
 
-End: {
-  label: "ドキュメント公開"
-  shape: circle
-  style.fill: "#a2eeaf"
-}
 
-Start -> init: "任意" {
+# --- Connections ---
+
+# Setup and Generation
+Lifecycle.init -> Configuration: "作成"
+Source-Code -> Lifecycle.generate: "読み込み"
+Configuration -> Lifecycle.generate: "読み込み"
+Lifecycle.generate -> Generated-Docs: "作成 / 上書き"
+Lifecycle.generate -> Lifecycle.init: {
+  label: "設定がない場合に実行"
   style.stroke-dash: 4
 }
-init -> generate: "設定"
-Start -> generate: "直接"
-generate -> refinement-cycle: "改良"
-refinement-cycle -> publish: "準備完了"
-generate -> publish: "直接デプロイ"
-publish -> End
+
+# Refinement Loop
+Generated-Docs <-> Lifecycle.Refinement: "読み書き"
+
+# Publishing
+Lifecycle.Refinement -> Lifecycle.publish
+Lifecycle.publish -> Published-Docs: "アップロード"
+
+# Utility Connections
+Utilities.prefs -> Configuration: "読み込み"
+Utilities.clear -> Configuration: "削除"
+Utilities.clear -> Generated-Docs: "削除"
 ```
 
 ---
 
+## `aigne doc init`
+
+対話式の設​​定ウィザードを手動で開始します。これは、新しいプロジェクトをセットアップしたり、既存のプロジェクトの構成を変更したりするのに役立ちます。ウィザードは、ソースコードのパスの定義、出力ディレクトリの設定、言語の選択、ドキュメントのスタイルと対象読者の定義をガイドします。
+
+### 使用例
+
+**セットアップウィザードを起動します：**
+
+```bash
+aigne doc init
+```
+![対話型セットアップウィザード完了のスクリーンショット。](../assets/screenshots/doc-complete-setup.png)
+
+DocSmithをニーズに合わせて調整する方法の詳細については、[設定ガイド](./configuration.md)を参照してください。
+
+---
+
 ## `aigne doc generate`
 
-ソースコードを分析し、設定に基づいてドキュメント一式を生成します。設定が見つからない場合は、対話式のセットアップウィザードが自動的に起動します。
+ソースコードを分析し、設定に基づいて完全なドキュメントセットを生成します。設定が見つからない場合は、自動的に対話式のセットアップウィザード（`aigne doc init`）を起動します。
+
+![generateコマンド実行中のスクリーンショット。](../assets/screenshots/doc-generate.png)
 
 ### オプション
 
-| オプション          | タイプ  | 説明                                                                                          |
-| ------------------- | ------- | --------------------------------------------------------------------------------------------- |
-| `--feedback`        | string  | ドキュメント全体の構造を調整および改良するためのフィードバックを提供します。                    |
-| `--forceRegenerate` | boolean | 既存のコンテンツを破棄し、すべてのドキュメントを最初から再生成します。                        |
-| `--model`           | string  | 生成に使用する特定の言語モデルを指定します（例：`openai:gpt-4o`）。デフォルトを上書きします。 |
+| オプション | タイプ | 説明 |
+| :------------------ | :------ | :------------------------------------------------------------------------------------------------------- |
+| `--forceRegenerate` | boolean | 既存のコンテンツを破棄し、すべてのドキュメントを最初から再生成します。 |
+| `--feedback` | string | ドキュメント全体の構造を調整・改良するためのフィードバックを提供します。 |
+| `--model` | string | 生成に使用する特定の言語モデルを指定します（例：`openai:gpt-4o`）。デフォルト設定を上書きします。 |
 
 ### 使用例
 
-**ドキュメントを生成または更新する：**
+**ドキュメントを生成または更新します：**
 
 ```bash
 aigne doc generate
 ```
 
-**すべてのドキュメントを強制的に再生成する：**
+**すべてのドキュメントの完全な再生成を強制します：**
 
 ```bash
 aigne doc generate --forceRegenerate
 ```
 
-**フィードバックをもとにドキュメント構造を改良する：**
+**フィードバックを反映してドキュメント構造を改良します：**
 
 ```bash
 aigne doc generate --feedback "APIの例のセクションを新しく追加し、「概要」ページを削除してください。"
 ```
 
-**AIGNE Hubの特定のモデルを使用して生成する：**
+**特定のモデルを使用して生成します：**
 
 ```bash
-aigne doc generate --model google:gemini-1.5-flash
+aigne doc generate --model openai:gpt-4o
 ```
 
 ---
 
 ## `aigne doc update`
 
-特定のドキュメントを最適化し、再生成します。対話形式で実行してドキュメントを選択するか、オプションで直接指定することができます。これは、プロジェクト全体を再生成することなく、フィードバックに基づいて対象を絞った改善を行うのに役立ちます。
+特定のドキュメントを最適化し、再生成します。対話形式で実行してドキュメントを選択するか、オプションで直接指定できます。これは、プロジェクト全体を再生成することなく、フィードバックに基づいて的を絞った改善を行うのに役立ちます。
+
+![updateコマンド実行中のスクリーンショット。](../assets/screenshots/doc-update.png)
 
 ### オプション
 
-| オプション   | タイプ  | 説明                                                                                |
-| ---------- | ----- | ----------------------------------------------------------------------------------- |
-| `--docs`     | array | 再生成するドキュメントのパスのリスト。複数回使用できます。                          |
-| `--feedback` | string | 選択したドキュメントのコンテンツを改善するための具体的なフィードバックを提供します。|
+| オプション | タイプ | 説明 |
+| :--------- | :---- | :-------------------------------------------------------------------------- |
+| `--docs` | array | 再生成するドキュメントのパスのリスト。複数回指定できます。 |
+| `--feedback` | string | 選択したドキュメントのコンテンツを改善するための具体的なフィードバックを提供します。 |
 
 ### 使用例
 
-**更新するドキュメントを選択するための対話セッションを開始する：**
+**対話セッションを開始して更新するドキュメントを選択します：**
 
 ```bash
 aigne doc update
 ```
 
-**特定のドキュメントを対象を絞ったフィードバックで更新する：**
+**特定のドキュメントを的を絞ったフィードバックで更新します：**
 
 ```bash
-aigne doc update --docs overview.md --feedback "より詳細なFAQ項目を追加してください"
+aigne doc update --docs /overview --feedback "より詳細なFAQ項目を追加してください"
 ```
 
 ---
 
 ## `aigne doc translate`
 
-既存のドキュメントを1つ以上の言語に翻訳します。対話形式で実行してドキュメントと言語を選択するか、引数として指定して非対話形式で実行することができます。
+既存のドキュメントを1つ以上の言語に翻訳します。対話形式で実行してドキュメントや言語を選択することも、引数として指定して非対話形式で実行することもできます。
+
+![translateコマンド実行中のスクリーンショット。](../assets/screenshots/doc-translate.png)
 
 ### オプション
 
-| オプション     | タイプ  | 説明                                                                                             |
-| ------------ | ----- | ------------------------------------------------------------------------------------------------ |
-| `--docs`       | array | 翻訳するドキュメントのパスのリスト。複数回使用できます。                                         |
-| `--langs`      | array | ターゲット言語コードのリスト（例：`zh`、`ja`）。複数回使用できます。                               |
-| `--feedback`   | string | 翻訳の品質を向上させるためのフィードバックを提供します。                                           |
-| `--glossary`   | string | 言語間で一貫した用語を確保するための用語集ファイルへのパス。`@path/to/glossary.md` を使用します。 |
+| オプション | タイプ | 説明 |
+| :--------- | :---- | :----------------------------------------------------------------------------------- |
+| `--docs` | array | 翻訳するドキュメントのパスのリスト。複数回指定できます。 |
+| `--langs` | array | 翻訳先の言語コードのリスト（例：`zh-CN`、`ja`）。複数回指定できます。 |
+| `--feedback` | string | 翻訳の質を向上させるためのフィードバックを提供します。 |
+| `--glossary` | string | 言語間で一貫した用語を確保するための用語集ファイルへのパス。`@path/to/glossary.md`を使用します。 |
 
 ### 使用例
 
-**対話型の翻訳セッションを開始する：**
+**対話式の翻訳セッションを開始します：**
 
 ```bash
 aigne doc translate
 ```
 
-**特定のドキュメントを中国語と日本語に翻訳する：**
+**特定のドキュメントを中国語と日本語に翻訳します：**
 
 ```bash
-aigne doc translate --langs zh --langs ja --docs examples.md --docs overview.md
+aigne doc translate --langs zh-CN --langs ja --docs /features/generate-documentation --docs /overview
 ```
 
-**用語集とフィードバックを使用して、より高品質な翻訳を行う：**
+**用語集とフィードバックを使用して翻訳品質を向上させます：**
 
 ```bash
-aigne doc translate --glossary @glossary.md --feedback "専門用語を一貫して使用してください"
+aigne doc translate --glossary @glossary.md --feedback "技術用語を一貫して使用してください"
 ```
 
 ---
 
 ## `aigne doc publish`
 
-生成されたドキュメントをDiscuss Kitプラットフォームに公開します。公式のAIGNE DocSmithプラットフォーム、または自己ホスト型のインスタンスに公開できます。
+ドキュメントを公開し、共有可能なリンクを生成します。このコマンドは、コンテンツをDiscuss Kitインスタンスにアップロードします。公式のAIGNE DocSmithプラットフォームを使用するか、独自の[Discuss Kit](https://www.web3kit.rocks/discuss-kit)インスタンスを実行できます。
+
+![publishコマンド実行中のスクリーンショット。](../assets/screenshots/doc-publish.png)
 
 ### オプション
 
-| オプション   | タイプ  | 説明                                                                                         |
-| ---------- | ------ | -------------------------------------------------------------------------------------------- |
-| `--appUrl` | string | 自己ホスト型のDiscuss KitインスタンスのURL。指定しない場合、コマンドは対話形式で実行されます。 |
+| オプション | タイプ | 説明 |
+| :------- | :----- | :------------------------------------------------------------------------------------------------------ |
+| `--appUrl` | string | セルフホストしているDiscuss KitインスタンスのURL。指定しない場合、コマンドは対話形式で実行されます。 |
 
 ### 使用例
 
-**対話型の公開セッションを開始する：**
+**対話式の公開セッションを開始します：**
 
 ```bash
 aigne doc publish
 ```
 
-**自己ホスト型のインスタンスに直接公開する：**
+**セルフホストのインスタンスに直接公開します：**
 
 ```bash
 aigne doc publish --appUrl https://your-discuss-kit-instance.com
@@ -195,16 +263,49 @@ aigne doc publish --appUrl https://your-discuss-kit-instance.com
 
 ---
 
-## `aigne doc init`
+## `aigne doc prefs`
 
-対話式の構成ウィザードを手動で開始します。これは、新しいプロジェクトを設定したり、既存のプロジェクトの構成を変更したりするのに役立ちます。ウィザードは、ソースコードのパスの定義、出力ディレクトリの設定、言語の選択、ドキュメントのスタイルと対象読者の定義を案内します。
+ユーザー設定とフィードバックに基づくルールを管理します。DocSmithは時間とともにフィードバックから学習し、永続的な設定を作成します。このコマンドを使用すると、これらの学習済みルールを表示、切り替え、または削除できます。
+
+### オプション
+
+| オプション | タイプ | 説明 |
+| :------- | :------ | :------------------------------------------------------------------------- |
+| `--list` | boolean | 保存されているすべての設定を一覧表示します。 |
+| `--remove` | boolean | 対話形式で1つ以上の設定を選択して削除するように促します。 |
+| `--toggle` | boolean | 対話形式で設定を選択し、その有効状態を切り替えるように促します。 |
+| `--id` | array | 直接削除または切り替える1つ以上の設定IDを指定します。 |
 
 ### 使用例
 
-**セットアップウィザードを起動する：**
+**保存されているすべての設定を一覧表示します：**
 
 ```bash
-aigne doc init
+aigne doc prefs --list
 ```
 
-DocSmithをニーズに合わせて調整する方法の詳細については、[設定ガイド](./configuration.md)を参照してください。
+**対話式の削除モードを開始します：**
+
+```bash
+aigne doc prefs --remove
+```
+
+**IDで特定の設定を切り替えます：**
+
+```bash
+aigne doc prefs --toggle --id "pref_2a1dfe2b09695aab"
+```
+
+---
+
+## `aigne doc clear`
+
+ローカルに保存されたデータを消去するための対話セッションを起動します。これを使用して、生成されたドキュメント、ドキュメント構造の設定、またはキャッシュされた認証トークンを削除できます。
+
+### 使用例
+
+**対話式のクリーンアッププロセスを開始します：**
+
+```bash
+aigne doc clear
+```