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

package/docs/cli-reference.ja.md

@@ -1,193 +1,252 @@
-# CLIコマンドリファレンス
+# CLI コマンドリファレンス
 
-このガイドでは、利用可能なすべての `aigne doc` サブコマンド、その引数、およびオプションのリファレンスを提供します。コマンドラインインターフェースを最大限に活用したいユーザーを対象としています。
+このガイドは、利用可能なすべての `aigne doc` サブコマンド、その引数、およびオプションに関する包括的なリファレンスを提供します。コマンドラインインターフェースを最大限に活用したいユーザーを対象としています。
 
-一般的な構文は次のとおりです。
+一般的な構文は次のとおりです:
 
-```bash
+```bash command
 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
+  }
 
-  update: {
-    label: "aigne doc update\n(単一ドキュメントの改良)"
+  generate: {
+    label: "2. 生成\n`aigne doc generate`"
+    shape: rectangle
   }
-  translate: {
-    label: "aigne doc translate\n(コンテンツのローカライズ)"
+
+  Refinement: {
+    label: "3. 改良 (反復)"
+    grid-columns: 2
+
+    update: {
+      label: "更新\n`aigne doc update`"
+      shape: rectangle
+    }
+    translate: {
+      label: "翻訳\n`aigne doc translate`"
+      shape: rectangle
+    }
   }
-}
 
-publish: {
-  label: "aigne doc publish\n(ドキュメントのデプロイ)"
-  shape: rectangle
+  publish: {
+    label: "4. 公開\n`aigne doc publish`"
+    shape: rectangle
+  }
 }
 
-End: {
-  label: "ドキュメント公開"
-  shape: circle
-  style.fill: "#a2eeaf"
+# --- Utility Commands ---
+Utilities: {
+  label: "ユーティリティコマンド"
+  grid-columns: 2
+  
+  prefs: {
+    label: "設定の表示\n`aigne doc prefs`"
+    shape: rectangle
+  }
+  clear: {
+    label: "データのクリア\n`aigne doc clear`"
+    shape: rectangle
+  }
 }
 
-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
 ```
 
+DocSmithをニーズに合わせて調整する方法の詳細については、[設定ガイド](./configuration.md)を参照してください。
+
 ---
 
 ## `aigne doc generate`
 
-ソースコードを分析し、設定に基づいてドキュメント一式を生成します。設定が見つからない場合は、対話式のセットアップウィザードが自動的に起動します。
+ソースコードを分析し、設定に基づいてドキュメントの完全なセットを生成します。設定が見つからない場合は、対話式の設​​定ウィザード (`aigne doc init`) が自動的に起動します。
 
 ### オプション
 
-| オプション          | タイプ  | 説明                                                                                          |
-| ------------------- | ------- | --------------------------------------------------------------------------------------------- |
-| `--feedback`        | string  | ドキュメント全体の構造を調整および改良するためのフィードバックを提供します。                    |
-| `--forceRegenerate` | boolean | 既存のコンテンツを破棄し、すべてのドキュメントを最初から再生成します。                        |
-| `--model`           | string  | 生成に使用する特定の言語モデルを指定します（例：`openai:gpt-4o`）。デフォルトを上書きします。 |
+| オプション              | タイプ    | 説明                                                                                                   |
+| ------------------- | ------- | ------------------------------------------------------------------------------------------------------------- |
+| `--forceRegenerate` | boolean | 既存のコンテンツを破棄し、すべてのドキュメントを最初から再生成します。                                     |
+| `--feedback`        | string  | ドキュメント全体の構造を調整および改良するためのフィードバックを提供します。                                   |
+| `--model`           | string  | 生成に使用する特定の言語モデルを指定します (例: `anthropic:claude-3-5-sonnet`)。デフォルトを上書きします。 |
 
 ### 使用例
 
-**ドキュメントを生成または更新する：**
+**ドキュメントを生成または更新する:**
 
 ```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`
 
-特定のドキュメントを最適化し、再生成します。対話形式で実行してドキュメントを選択するか、オプションで直接指定することができます。これは、プロジェクト全体を再生成することなく、フィードバックに基づいて対象を絞った改善を行うのに役立ちます。
+特定のドキュメントを最適化し、再生成します。対話形式で実行してドキュメントを選択するか、オプションで直接指定できます。これは、プロジェクト全体を再生成することなく、フィードバックに基づいて対象を絞った改善を行うのに役立ちます。
 
 ### オプション
 
-| オプション   | タイプ  | 説明                                                                                |
-| ---------- | ----- | ----------------------------------------------------------------------------------- |
-| `--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.md --feedback "より詳細なFAQ項目を追加してください"
 ```
 
 ---
 
 ## `aigne doc translate`
 
-既存のドキュメントを1つ以上の言語に翻訳します。対話形式で実行してドキュメントと言語を選択するか、引数として指定して非対話形式で実行することができます。
+既存のドキュメントを1つ以上の言語に翻訳します。対話形式で実行してドキュメントと言語を選択するか、引数として指定して非対話形式で実行できます。
 
 ### オプション
 
-| オプション     | タイプ  | 説明                                                                                             |
-| ------------ | ----- | ------------------------------------------------------------------------------------------------ |
-| `--docs`       | array | 翻訳するドキュメントのパスのリスト。複数回使用できます。                                         |
-| `--langs`      | array | ターゲット言語コードのリスト（例：`zh`、`ja`）。複数回使用できます。                               |
-| `--feedback`   | string | 翻訳の品質を向上させるためのフィードバックを提供します。                                           |
+| オプション       | タイプ  | 説明                                                                                                |
+| ------------ | ----- | ---------------------------------------------------------------------------------------------------------- |
+| `--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.md --docs /overview.md
 ```
 
-**用語集とフィードバックを使用して、より高品質な翻訳を行う：**
+**用語集とフィードバックを使用して品質を向上させる翻訳:**
 
 ```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)インスタンスを実行できます。
 
 ### オプション
 
-| オプション   | タイプ  | 説明                                                                                         |
-| ---------- | ------ | -------------------------------------------------------------------------------------------- |
-| `--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 +254,28 @@ aigne doc publish --appUrl https://your-discuss-kit-instance.com
 
 ---
 
-## `aigne doc init`
+## `aigne doc prefs`
 
-対話式の構成ウィザードを手動で開始します。これは、新しいプロジェクトを設定したり、既存のプロジェクトの構成を変更したりするのに役立ちます。ウィザードは、ソースコードのパスの定義、出力ディレクトリの設定、言語の選択、ドキュメントのスタイルと対象読者の定義を案内します。
+プロジェクトの現在の設定を表示します。これは読み取り専用のコマンドで、`init` または `generate` プロセス中に適用された設定を確認するのに役立ちます。
 
 ### 使用例
 
-**セットアップウィザードを起動する：**
+**現在のプロジェクト設定を表示する:**
 
 ```bash
-aigne doc init
+aigne doc prefs
 ```
 
-DocSmithをニーズに合わせて調整する方法の詳細については、[設定ガイド](./configuration.md)を参照してください。
+---
+
+## `aigne doc clear`
+
+ローカルに保存されたデータをクリアするための対話セッションを起動します。これを使用して、生成されたドキュメント、ドキュメント構造の設定、またはキャッシュされた認証トークンを削除できます。
+
+### 使用例
+
+**対話式のクリーンアッププロセスを開始する:**
+
+```bash
+aigne doc clear
+```

package/docs/cli-reference.md

@@ -1,83 +1,142 @@
 # CLI Command Reference
 
-This guide provides a reference for all available `aigne doc` sub-commands, their arguments, and options. It is intended for users who want to use the command-line interface to its full potential.
+This guide provides a comprehensive reference for all available `aigne doc` sub-commands, their arguments, and options. It is intended for users who want to utilize the command-line interface to its full potential.
 
 The general syntax is:
 
-```bash
+```bash command
 aigne doc <command> [options]
 ```
 
 ### Command Workflow
 
-The following diagram illustrates the typical lifecycle of creating and maintaining documentation with DocSmith's CLI commands:
+The following diagram illustrates the typical lifecycle of creating and maintaining documentation with DocSmith's CLI commands, along with the data they interact with.
 
 ```d2
 direction: down
 
-Start: {
-  label: "Project Setup"
-  shape: circle
+# Artifacts
+Source-Code: {
+  label: "Source Code"
+  shape: cylinder
 }
-
-init: {
-  label: "aigne doc init\n(Interactive Setup)"
-  shape: rectangle
+Configuration: {
+  label: "Configuration\n(.aigne/doc-smith/config.yml)"
+  shape: cylinder
 }
-
-generate: {
-  label: "aigne doc generate\n(Create/Update All Docs)"
-  shape: rectangle
+Generated-Docs: {
+  label: "Generated Docs"
+  shape: cylinder
+}
+Published-Docs: {
+  label: "Published Site"
+  shape: cylinder
 }
 
-refinement-cycle: {
-  label: "Refinement Cycle"
-  shape: rectangle
-  grid-columns: 2
+# --- Core Workflow ---
+Lifecycle: {
+  label: "Documentation Lifecycle"
+  
+  init: {
+    label: "1. Init\n`aigne doc init`"
+    shape: rectangle
+  }
 
-  update: {
-    label: "aigne doc update\n(Refine Single Doc)"
+  generate: {
+    label: "2. Generate\n`aigne doc generate`"
+    shape: rectangle
   }
-  translate: {
-    label: "aigne doc translate\n(Localize Content)"
+
+  Refinement: {
+    label: "3. Refine (Iterative)"
+    grid-columns: 2
+
+    update: {
+      label: "Update\n`aigne doc update`"
+      shape: rectangle
+    }
+    translate: {
+      label: "Translate\n`aigne doc translate`"
+      shape: rectangle
+    }
   }
-}
 
-publish: {
-  label: "aigne doc publish\n(Deploy Docs)"
-  shape: rectangle
+  publish: {
+    label: "4. Publish\n`aigne doc publish`"
+    shape: rectangle
+  }
 }
 
-End: {
-  label: "Docs Live"
-  shape: circle
-  style.fill: "#a2eeaf"
+# --- Utility Commands ---
+Utilities: {
+  label: "Utility Commands"
+  grid-columns: 2
+  
+  prefs: {
+    label: "View Config\n`aigne doc prefs`"
+    shape: rectangle
+  }
+  clear: {
+    label: "Clear Data\n`aigne doc clear`"
+    shape: rectangle
+  }
 }
 
-Start -> init: "Optional" {
+
+# --- Connections ---
+
+# Setup and Generation
+Lifecycle.init -> Configuration: "Creates"
+Source-Code -> Lifecycle.generate: "Reads"
+Configuration -> Lifecycle.generate: "Reads"
+Lifecycle.generate -> Generated-Docs: "Creates / Overwrites"
+Lifecycle.generate -> Lifecycle.init: {
+  label: "Runs if no config"
   style.stroke-dash: 4
 }
-init -> generate: "Configure"
-Start -> generate: "Direct"
-generate -> refinement-cycle: "Refine"
-refinement-cycle -> publish: "Ready"
-generate -> publish: "Direct Deploy"
-publish -> End
+
+# Refinement Loop
+Generated-Docs <-> Lifecycle.Refinement: "Reads & Writes"
+
+# Publishing
+Lifecycle.Refinement -> Lifecycle.publish
+Lifecycle.publish -> Published-Docs: "Uploads to"
+
+# Utility Connections
+Utilities.prefs -> Configuration: "Reads"
+Utilities.clear -> Configuration: "Deletes"
+Utilities.clear -> Generated-Docs: "Deletes"
 ```
 
 ---
 
+## `aigne doc init`
+
+Manually starts the interactive configuration wizard. This is useful for setting up a new project or modifying the configuration of an existing one. The wizard guides you through defining source code paths, setting output directories, choosing languages, and defining the documentation's style and target audience.
+
+### Usage Example
+
+**Launch the setup wizard:**
+
+```bash
+aigne doc init
+```
+
+For more details on how to tailor DocSmith to your needs, see the [Configuration Guide](./configuration.md).
+
+---
+
 ## `aigne doc generate`
 
-Analyzes your source code and generates a complete set of documentation based on your configuration. If no configuration is found, it automatically launches the interactive setup wizard.
+Analyzes your source code and generates a complete set of documentation based on your configuration. If no configuration is found, it automatically launches the interactive setup wizard (`aigne doc init`).
 
 ### Options
 
 | Option              | Type    | Description                                                                                                   |
 | ------------------- | ------- | ------------------------------------------------------------------------------------------------------------- |
-| `--feedback`        | string  | Provides feedback to adjust and refine the overall documentation structure.                                   |
 | `--forceRegenerate` | boolean | Discards existing content and regenerates all documentation from scratch.                                     |
-| `--model`           | string  | Specifies a particular large language model to use for generation (e.g., `openai:gpt-4o`). Overrides the default. |
+| `--feedback`        | string  | Provides feedback to adjust and refine the overall documentation structure.                                   |
+| `--model`           | string  | Specifies a particular large language model to use for generation (e.g., `anthropic:claude-3-5-sonnet`). Overrides the default. |
 
 ### Usage Examples
 
@@ -93,16 +152,16 @@ aigne doc generate
 aigne doc generate --forceRegenerate
 ```
 
-**Refine the document structure with feedback:**
+**Refine the documentation structure with feedback:**
 
 ```bash
 aigne doc generate --feedback "Add a new section for API examples and remove the 'About' page."
 ```
 
-**Generate using a specific model from AIGNE Hub:**
+**Generate using a specific model:**
 
 ```bash
-aigne doc generate --model google:gemini-1.5-flash
+aigne doc generate --model openai:gpt-4o
 ```
 
 ---
@@ -115,7 +174,7 @@ Optimizes and regenerates specific documents. You can run it interactively to se
 
 | Option     | Type  | Description                                                                                 |
 | ---------- | ----- | ------------------------------------------------------------------------------------------- |
-| `--docs`     | array | A list of document paths to regenerate. Can be used multiple times.                         |
+| `--docs`     | array | A list of document paths to regenerate. Can be specified multiple times.                         |
 | `--feedback` | string | Provides specific feedback to improve the content of the selected document(s).              |
 
 ### Usage Examples
@@ -129,7 +188,7 @@ aigne doc update
 **Update a specific document with targeted feedback:**
 
 ```bash
-aigne doc update --docs overview.md --feedback "Add more detailed FAQ entries"
+aigne doc update --docs /overview.md --feedback "Add more detailed FAQ entries"
 ```
 
 ---
@@ -142,8 +201,8 @@ Translates existing documentation into one or more languages. It can be run inte
 
 | Option       | Type  | Description                                                                                                |
 | ------------ | ----- | ---------------------------------------------------------------------------------------------------------- |
-| `--docs`       | array | A list of document paths to translate. Can be used multiple times.                                         |
-| `--langs`      | array | A list of target language codes (e.g., `zh`, `ja`). Can be used multiple times.                            |
+| `--docs`       | array | A list of document paths to translate. Can be specified multiple times.                                         |
+| `--langs`      | array | A list of target language codes (e.g., `zh-CN`, `ja`). Can be specified multiple times.                            |
 | `--feedback`   | string | Provides feedback to improve the quality of the translation.                                               |
 | `--glossary`   | string | Path to a glossary file to ensure consistent terminology across languages. Use `@path/to/glossary.md`. |
 
@@ -158,10 +217,10 @@ aigne doc translate
 **Translate specific documents into Chinese and Japanese:**
 
 ```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.md --docs /overview.md
 ```
 
-**Translate with a glossary and feedback for better quality:**
+**Translate with a glossary and feedback for improved quality:**
 
 ```bash
 aigne doc translate --glossary @glossary.md --feedback "Use technical terminology consistently"
@@ -171,7 +230,7 @@ aigne doc translate --glossary @glossary.md --feedback "Use technical terminolog
 
 ## `aigne doc publish`
 
-Publishes your generated documentation to a Discuss Kit platform. You can publish to the official AIGNE DocSmith platform or to your own self-hosted instance.
+Publishes your documentation and generates a shareable link. This command uploads your content to a Discuss Kit instance. You can use the official AIGNE DocSmith platform or run your own instance of [Discuss Kit](https://www.web3kit.rocks/discuss-kit).
 
 ### Options
 
@@ -195,16 +254,28 @@ aigne doc publish --appUrl https://your-discuss-kit-instance.com
 
 ---
 
-## `aigne doc init`
+## `aigne doc prefs`
 
-Manually starts the interactive configuration wizard. This is useful for setting up a new project or modifying the configuration of an existing one. The wizard guides you through defining source code paths, setting output directories, choosing languages, and defining the documentation's style and target audience.
+Displays the current configuration settings for the project. This is a read-only command that helps you verify the settings applied during the `init` or `generate` process.
 
 ### Usage Example
 
-**Launch the setup wizard:**
+**View current project configuration:**
 
 ```bash
-aigne doc init
+aigne doc prefs
 ```
 
-For more details on how to tailor DocSmith to your needs, see the [Configuration Guide](./configuration.md).
+---
+
+## `aigne doc clear`
+
+Launches an interactive session to clear locally stored data. This can be used to remove the generated documentation, the document structure configuration, or cached authentication tokens.
+
+### Usage Example
+
+**Start the interactive cleanup process:**
+
+```bash
+aigne doc clear
+```