diff options
| author | 魏曹先生 <1992414357@qq.com> | 2026-03-12 20:24:03 +0800 |
|---|---|---|
| committer | 魏曹先生 <1992414357@qq.com> | 2026-03-12 20:24:03 +0800 |
| commit | 2cc0f1766dec2b0b9eb6bfe0d499f2b6d36a591f (patch) | |
| tree | 9b1ebbc5e37901d2be32acbd80aeaede833e5e05 /resources/helpdoc | |
| parent | b99398fb18b209143554ee936592f129610b90ca (diff) | |
Update welcome documentation for global flags and commands
Diffstat (limited to 'resources/helpdoc')
| -rw-r--r-- | resources/helpdoc/Welcome_To_JVCS.en.md | 46 | ||||
| -rw-r--r-- | resources/helpdoc/Welcome_To_JVCS.zh-CN.md | 44 | ||||
| -rw-r--r-- | resources/helpdoc/commands/hexdump.zh-CN.md | 2 | ||||
| -rw-r--r-- | resources/helpdoc/commands/sheetdump.zh-CN.md | 12 | ||||
| -rw-r--r-- | resources/helpdoc/commands/sheetedit.zh-CN.md | 4 |
5 files changed, 98 insertions, 10 deletions
diff --git a/resources/helpdoc/Welcome_To_JVCS.en.md b/resources/helpdoc/Welcome_To_JVCS.en.md index 8161371..3a7cf06 100644 --- a/resources/helpdoc/Welcome_To_JVCS.en.md +++ b/resources/helpdoc/Welcome_To_JVCS.en.md @@ -1 +1,45 @@ -> Welcome to the `JustEnoughVCS` CLI program! +> Welcome to the `JustEnoughVCS` CLI! + +## Basic Usage +jvn <SUBCOMMAND> <ARGUMENT: ?> <FLAG: ?> + +## Global Flags +Global flags for command debugging. + +### Language +**Flag**: `--lang <LANGUAGE>` +Set program language. +Options: en / zh-CN + +### Confirm +**Flag**: `--confirm` or `-C` +Skip confirmation prompts. + +### Help +**Flag**: `--help` or `-h` +Show command help. +> Or use `jvn helpdoc <DOCUMENT>` +> for full docs. + +### Renderer Override +**Flag**: `--renderer <RENDERER>` +Override output format. +Options: json / json-pretty / +__ ron / ron-pretty / +__ yaml / toml + +### No Error Output +**Flag**: `--no-error-logs` +Suppress error output. + +### No Progress Bar +**Flag**: `--no-progress` +Disable progress bar. + +### Quiet Output +**Flag**: `--quiet` or `-q` +Suppress all output for scripts. + +### Log Output +**Flag**: `--verbose` or `-V` +Enable full output for debugging. diff --git a/resources/helpdoc/Welcome_To_JVCS.zh-CN.md b/resources/helpdoc/Welcome_To_JVCS.zh-CN.md index a67c5b0..1f57a75 100644 --- a/resources/helpdoc/Welcome_To_JVCS.zh-CN.md +++ b/resources/helpdoc/Welcome_To_JVCS.zh-CN.md @@ -1 +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` +启用所有输出,用于追溯程序错误 diff --git a/resources/helpdoc/commands/hexdump.zh-CN.md b/resources/helpdoc/commands/hexdump.zh-CN.md index cbc743f..b1e7996 100644 --- a/resources/helpdoc/commands/hexdump.zh-CN.md +++ b/resources/helpdoc/commands/hexdump.zh-CN.md @@ -1,4 +1,4 @@ > 打印二进制信息 ## 使用 -jvn hexdump <FILE> +jvn hexdump <文件> diff --git a/resources/helpdoc/commands/sheetdump.zh-CN.md b/resources/helpdoc/commands/sheetdump.zh-CN.md index e1a827f..5872029 100644 --- a/resources/helpdoc/commands/sheetdump.zh-CN.md +++ b/resources/helpdoc/commands/sheetdump.zh-CN.md @@ -1,10 +1,10 @@ -> 可视化地输出 `Sheet` 的内部结构 +> 可视化地输出 `结构表` 的内部结构 ## 使用 -jvn sheetdump <SHEET_FILE> # 默认输出 -jvn sheetdump <SHEET_FILE> --no-sort # 无排序 -jvn sheetdump <SHEET_FILE> --no-pretty # 无美化 +jvn sheetdump <结构表文件> # 默认输出 +jvn sheetdump <结构表文件> --no-sort # 无排序 +jvn sheetdump <结构表文件> --no-pretty # 无美化 ## 提示 -您也可以使用 `渲染器重载` 来访问 `Sheet` 的内部结构,例如 -jvn sheetdump <SHEET_FILE> --renderer json | jq ".mappings" +您也可以使用 `渲染器重载` 来访问 `结构表` 的内部结构,例如 +jvn sheetdump <结构表文件> --renderer json | jq ".mappings" diff --git a/resources/helpdoc/commands/sheetedit.zh-CN.md b/resources/helpdoc/commands/sheetedit.zh-CN.md index b94ee34..d45224b 100644 --- a/resources/helpdoc/commands/sheetedit.zh-CN.md +++ b/resources/helpdoc/commands/sheetedit.zh-CN.md @@ -1,7 +1,7 @@ -> 使用系统编辑器修改 `Sheet` 文件 +> 使用系统编辑器修改 `结构表` 文件 ## 使用 -jvn sheetedit <FILE> +jvn sheetedit <文件> ## 注意 它读取按照以下优先级寻找命令行编辑器程序: |
