Add environment variable documentation for CLI

3 files changed, 94 insertions, 2 deletions

diff --git a/resources/helpdoc/environments.en.md b/resources/helpdoc/environments.en.md
new file mode 100644
index 0000000..3ad4e26
--- /dev/null
+++ b/resources/helpdoc/environments.en.md
@@ -0,0 +1,47 @@
+> `JustEnoughVCS` CLI Environments
+
+## Usage
+Environment variables can be set before invoking a command. 
+The usage depends on your system:
+
+**Linux/macOS (Bash/Zsh, etc.):**
+__  JV\_KEY=value jvn <subcommand>
+
+**Windows (Command Prompt):**
+__  set JV\_KEY=value && jvn <subcommand>
+
+**Windows (PowerShell):**
+__  $env:JV\_KEY="value"; jvn <subcommand>
+
+## Environment Variables
+`jvn` provides several environment variables to 
+__  control certain behaviors of the command line.
+
+### Default Text Editor
+**Key**: JV\_TEXT\_EDITOR
+**Value**: [Program]
+
+Example:
+__  JV\_TEXT\_EDITOR="nano"
+
+### Help Documentation Viewer
+**Key**: JV\_HELPDOC\_VIEWER
+**Value**: [Enable: 1] or [Disable: 0]
+
+Example:
+__  # Turn off help documentation viewer output
+__  JV\_HELPDOC\_VIEWER=0 jvn -h
+
+### Language
+**Key**: JV\_LANG
+**Value**: [Language]
+
+Example:
+__  JV\_LANG=en jvn -v
+
+### Pager
+**Key**: JV\_PAGER
+**Value**: [Program]
+
+Example:
+__  JV\_PAGER="less"
diff --git a/resources/helpdoc/environments.zh-CN.md b/resources/helpdoc/environments.zh-CN.md
new file mode 100644
index 0000000..234c6b7
--- /dev/null
+++ b/resources/helpdoc/environments.zh-CN.md
@@ -0,0 +1,45 @@
+> `JustEnoughVCS` 命令行程序环境变量设置
+
+## 用法
+环境变量可以在调用命令前设置，用法取决于您的系统：
+
+**Linux/macOS (Bash/Zsh等):**
+__  JV\_KEY=value jvn <子命令>
+
+**Windows (命令提示符):**
+__  set JV\_KEY=value && jvn <子命令>
+
+**Windows (PowerShell):**
+__  $env:JV\_KEY="value"; jvn <子命令>
+
+## 环境变量
+`jvn` 提供若干环境变量，用来控制命令行的部分行为逻辑
+
+### 默认编辑器
+**键**：JV\_TEXT\_EDITOR
+**值**：[二进制程序]
+
+例如：
+__  JV\_TEXT\_EDITOR="nano"
+
+### 帮助文档查看器
+**键**：JV\_HELPDOC\_VIEWER
+**值**：[启用：1] 或 [禁用：0]
+
+例如：
+__  # 关闭帮助文档查看器输出
+__  JV\_HELPDOC\_VIEWER=0 jvn -h
+
+### 语言
+**键**：JV\_LANG
+**值**: [语言]
+
+例如：
+__  JV\_LANG=zh-CN jvn -v
+
+### 分页器
+**键**：JV\_PAGER
+**值**：[二进制程序]
+
+例如：
+__  JV\_PAGER="less"
diff --git a/utils/src/env/helpdoc.rs b/utils/src/env/helpdoc.rs
index d9bce2c..ab2570e 100644
--- a/utils/src/env/helpdoc.rs
+++ b/utils/src/env/helpdoc.rs
@@ -1,6 +1,6 @@
 /// Gets the default help documentation setting based on environment variables.
 ///
-/// The function checks the JV_HELPDOC environment variable.
+/// The function checks the JV_HELPDOC_VIEWER environment variable.
 /// If the variable is set to "1", it returns true (enabled).
 /// If the variable is set to any other value, it returns false (disabled).
 /// If the variable is not set, it returns true (enabled by default).
@@ -8,7 +8,7 @@
 /// # Returns
 /// A boolean indicating whether help documentation is enabled
 pub fn get_helpdoc_enabled() -> bool {
-    match std::env::var("JV_HELPDOC") {
+    match std::env::var("JV_HELPDOC_VIEWER") {
         Ok(value) => value == "1",
         Err(_) => true,
     }