summaryrefslogtreecommitdiff
path: root/locales/help_docs
diff options
context:
space:
mode:
Diffstat (limited to 'locales/help_docs')
-rw-r--r--locales/help_docs/en.yml109
-rw-r--r--locales/help_docs/zh-CN.yml82
2 files changed, 108 insertions, 83 deletions
diff --git a/locales/help_docs/en.yml b/locales/help_docs/en.yml
index 5a12f8f..0878ee1 100644
--- a/locales/help_docs/en.yml
+++ b/locales/help_docs/en.yml
@@ -6,22 +6,24 @@ jvv:
help: |
**JustEnoughVCS Upstream Vault Commands**
This program directly creates, manages, and runs JustEnoughVCS upstream vaults.
- **Tip**: It directly operates on vault data - please operate with caution!
+ **Warning**: It directly operates on vault data - please operate with caution!
* With great power comes great responsibility *
- **Create Vault**:
- jvv create <VAULT_NAME> - Create a vault in the given directory name
- jvv init - Create a vault in the current directory
+ **VAULT**:
+ create <NAME> Create a vault in the given directory name
+ init Create a vault in the current directory
- **Query**:
- jvv here - Query information about the current vault
- jvv member list - Query all members
+ **QUERY**:
+ here Query information about the current vault
- **Member Management**:
- jvv member <register/remove> <MEMBER_NAME> - Register or remove members
+ **MEMBERS**:
+ member [list|register|remove]
+ list List members
+ register <MEMBER_NAME> Register a member
+ remove <MEMBER_NAME> Remove a member
- **Service**:
- jvv service listen - Run the server in the current vault
+ **SERVICES**:
+ service listen Run the server
Additionally, you can use jvv <CMD_NAME> --help to query more detailed help!
@@ -137,46 +139,47 @@ jv:
**JustEnoughVCS Local Workspace Commands**
This program connects to upstream vaults to synchronize and commit changes to local workspace files for collaborative work.
- **Common Aliases**:
+ **ALIASES**:
jv u Download latest information, jv t Track files, jv mv -a Auto-move files, jv in/out Import or export files
- **Create Workspace**:
- jv create <NAME> - Create a workspace in the given directory name
- jv init - Create a workspace in the current directory
-
- **Connect to Upstream Vault**:
- jv direct <UPSTREAM_ADDRESS> - Direct your workspace to this vault
- After specifying an upstream vault, your workspace will be *stained*, and you will not be able to connect to vaults with different identifiers
-
- jv unstain - Unstain your workspace (remove stain identifier), after which the workspace will be unrelated to any upstream vault
-
- **Account Management**:
- jv account list - List all accounts on this computer and whether private keys are registered
- jv account as <ACCOUNT_NAME> - Switch current account
- jv account add <ACCOUNT_NAME> - Add an account to this computer
- jv account remove <ACCOUNT_NAME> - Delete this account
- jv account movekey <ACCOUNT_NAME> <PRIVATE_KEY_FILE> - Move private key to specified account
-
- **Information Synchronization**:
- jv update - Download latest information from upstream workspace
-
- **Sheet Operations**:
- jv sheet list - List all sheets in the upstream workspace
- jv sheet use <SHEET_NAME> - Use the specified sheet to start current work (automatically created if it doesn't exist)
- jv sheet exit - Exit current work
-
- jv import <PACKAGE_NAME> - Import files from import area
- jv import <REFERENCE_SHEET_PATH> - Import files from reference sheet
- jv export <FILE> <SHEET_NAME> -m <DESCRIPTION> -n <PACKAGE_NAME> - Export specified file package to import area of other sheets
-
- **File Operations**
- jv move <FILE> <TO> - Safely rename files
- jv move auto - Automatically handle local file moves or renames
- jv track <FILE> - Track and upload files to upstream vault
-
- **Query Built-in Documentation**
- jv docs list - List all available documentation
- jv docs <DOC_NAME> - View content of specified documentation
+ **WORKSPACE**:
+ create <NAME> Create workspace
+ init Create workspace in current directory
+
+ **UPSTREAM VAULT**:
+ direct <UPSTREAM> Direct workspace to upstream vault
+ unstain Unstain workspace, clear association
+
+ **ACCOUNTS**:
+ account [list|as|add|remove|movekey]
+ list List accounts
+ as <ACCOUNT_NAME> Switch account in workspace
+ add <ACCOUNT_NAME> Add account to this computer
+ remove <ACCOUNT_NAME> Remove account from computer
+ movekey <ACCOUNT_NAME> <PRIVATE_KEY_FILE> Move private key file to specified account
+
+ **SYNC**:
+ update Download latest information
+
+ **SHEETS**:
+ sheet [list|use|exit]
+ list List all sheets
+ use Use sheet, start work
+ exit Exit sheet, clear current modifications
+
+ **FILE TRANSFER**
+ import <PACKAGE_NAME> Import files from import area
+ import <REFERENCE_SHEET_PATH> Import files from reference sheet
+ export <FILE> <SHEET_NAME> -m <DESCRIPTION> -n <PACKAGE_NAME> Export files to other sheets
+
+ **FILE OPERATIONS**
+ move <FILE> <TO> Safely rename files
+ move auto Automatically handle local file moves or renames
+ track <FILE> Track and upload files to upstream vault
+
+ **DOCUMENTATION**
+ docs list List all available documentation
+ docs <DOC_NAME> View content of specified documentation
or jv docs <DOC_NAME> -e - Return temporary path of specific documentation for editor opening
**Example**: jv docs get-started -e | nano
@@ -385,6 +388,10 @@ jv:
unstain: |
The current workspace is not stained, no need to unstain
+ not_stained: |
+ The current workspace is not stained, cannot perform the next operation!
+ **Tip**: Please first use `jv direct <upstream_address>` to direct to an upstream vault
+
warn:
unstain: |
This operation will disconnect the current workspace from the upstream vault `%{upstream}`
@@ -421,3 +428,7 @@ jv:
already_stained: |
Current workspace is already stained and cannot be directed to other upstream vaults with different identifiers
Please use `jv unstain` to remove the stain first
+
+ update:
+ success: |
+ Synchronized to latest information!
diff --git a/locales/help_docs/zh-CN.yml b/locales/help_docs/zh-CN.yml
index 4d3212e..82a71e2 100644
--- a/locales/help_docs/zh-CN.yml
+++ b/locales/help_docs/zh-CN.yml
@@ -9,18 +9,20 @@ jvv:
**注意**:它能直接操作库的数据,请谨慎使用!*(能力越大,责任越大)*
**创建库**:
- jvv create <名称> - 在给定的目录名称中创建库
- jvv init - 在当前目录中创建库
+ create <名称> 在给定的目录名称中创建库
+ init 在当前目录中创建库
**查询**:
- jvv here - 查询当前库的信息
- jvv member list - 查询所有成员
+ here 查询当前库的信息
**成员管理**:
- jvv member <register/remove> <成员名称> - 注册或删除成员
+ member [list|register|remove]
+ list 列出成员
+ register <成员名称> 注册成员
+ remove <成员名称> 移除成员
**服务**:
- jvv service listen - 在当前库中运行服务端
+ service listen 运行服务端
另外,您可以使用 jvv <命令名称> --help 来查询更详细的帮助!
@@ -134,44 +136,48 @@ jv:
**常用别名**:
jv u 下载最新信息,jv t 追踪文件,jv mv -a 自动移动文件,jv in/out 导入或导出文件
- **创建工作区**:
- jv create <名称> - 在给定名称的目录创建工作区
- jv init - 在当前目录创建工作区
+ **工作区**:
+ create <名称> 创建工作区
+ init 当前目录创建工作区
- **指向上游库**:
- jv direct <上游地址> - 将您的工作区指向该库
- 指定上游库后,您的工作区将被 *染色*,此后,您将无法连接至不同标识的库
+ **上游库**:
+ direct <上游地址> 定向到工作区到上游库
- jv unstain - 将您的工作区祛色(移除染色标识),此后该工作区将与上游库无关
+ unstain 祛色工作区,清除关联
- **账户管理**:
- jv account list - 列出该计算机所有的账户,以及是否注册私钥
- jv account as <账户名称> - 切换当前账户
- jv account add <账户名称> - 为当前计算机添加账户
- jv account remove <账户名称> - 删除该账户
- jv account movekey <账户名称> <私钥文件> - 移动私钥到指定账户
+ **账户**:
+ account [list|as|add|remove|movekey]
+ list 列出所有账户
+ as <账户名称> 设置该工作区使用的账户
+
+ add <账户名称> 为当前计算机添加账户
+ remove <账户名称> 从计算机删除账户
+
+ movekey <账户名称> <私钥文件> 移动私钥文件到指定账户
**信息同步**:
- jv update - 从上游工作区下载最新的信息
+ update 下载最新的信息
**表操作**:
- jv sheet list - 列出上游工作区的所有表
- jv sheet use <表名称> - 使用指定的表开始当前工作(不存在则自动创建)
- jv sheet exit - 退出当前工作
+ sheet [list|use|exit]
+ list 列出所有表
+ use 使用表,并开始工作
+ exit 退出表,清除当前修改
- jv import <文件包名称> - 从导入区导入文件
- jv import <参照表中目录> - 从参照表导入文件
- jv export <文件> <表名称> -m <描述> -n <文件包名称> - 导出指定的文件包到其他表的导入区
+ **文件传递**
+ import <文件包名称> 从导入区导入文件
+ import <参照表中目录> 从参照表导入文件
+ export <文件> <表名称> -m <描述> -n <文件包名称> 导出文件到其他表
**文件操作**
- jv move <文件> <到> - 安全地重命名文件
- jv move auto - 自动处理本地文件的移动或重命名
- jv track <文件> - 追踪、上传文件到上游库
-
- **查询内建文档**
- jv docs list - 列出所有可用的文档
- jv docs <文档名称> - 查看指定文档的内容
- 或 jv docs <文档名称> -e - 返回特定文档的临时路径以供编辑器打开
+ move <文件> <到> 安全地重命名文件
+ move auto 自动处理本地文件的移动或重命名
+ track <文件> 追踪、上传文件到上游库
+
+ **内建文档**
+ docs list 列出所有可用的文档
+ docs <文档名称> 查看指定文档的内容
+ 或 jv docs <文档名称> -e 返回特定文档的临时路径以供编辑器打开
**例如**:jv docs get-started -e | nano
您可以使用 jv <命令名称> --help 来查询更详细的帮助!
@@ -394,6 +400,10 @@ jv:
unstain: |
当前工作区并未被染色,无需祛色
+ not_stained: |
+ 当前工作区并未被染色,无法执行下一步操作!
+ **提示**:请先使用 `jv direct <上游地址>` 定向到上游库
+
warn:
unstain: |
此操作将会断开当前工作区与上游库 `%{upstream}` 的关联
@@ -429,3 +439,7 @@ jv:
already_stained: |
当前工作区已被染色,无法定向其他不同标识的上游库
请先使用 jv unstain 祛色
+
+ update:
+ success: |
+ 已同步至最新信息!