summaryrefslogtreecommitdiff
path: root/resources/helpdoc/commands.zh-CN.md
diff options
context:
space:
mode:
Diffstat (limited to 'resources/helpdoc/commands.zh-CN.md')
-rw-r--r--resources/helpdoc/commands.zh-CN.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/resources/helpdoc/commands.zh-CN.md b/resources/helpdoc/commands.zh-CN.md
new file mode 100644
index 0000000..fc734cf
--- /dev/null
+++ b/resources/helpdoc/commands.zh-CN.md
@@ -0,0 +1,45 @@
+> 欢迎使用 `JustEnoughVCS` 命令行程序!
+
+## 基本用法
+jvn <子命令> <参数: ?> <标识符: ?>
+
+## 通用标识符
+`jvn` 提供若干全局标识符,用于命令调试
+
+### 语言(Language)
+**符号**:`--lang <语言>`
+指定程序使用的语言
+可选:en / zh-CN
+
+### 确认
+**符号**:`--confirm` 或 `-C`
+部分命令需要显式确定,该符号将会跳过确认环节
+
+### 帮助
+**符号**:`--help` 或 `-h`
+打开帮助页面,以查询命令如何使用
+> 当然,您也可以用 `jvn helpdoc <文档>`
+> 来打开帮助文档页面
+
+### 渲染器覆盖
+**符号**:`--renderer <渲染器>`
+指定覆盖渲染器,将结果以指定格式输出
+可选:json / json-pretty /
+__ ron / ron-pretty
+__ yaml / toml /
+
+### 无错误输出
+**符号**:`--no-error-logs`
+当程序出现问题时,不会输出任何内容
+
+### 无进度条
+**符号**:`--no-progress`
+关闭进度条显示
+
+### 安静输出
+**符号**:`--quiet` 或 `-q`
+关闭所有输出,保持终端页面干净,用于自动化脚本
+
+### 日志输出
+**符号**:`--verbose` 或 `-V`
+启用所有输出,用于追溯程序错误