From 3a581e7410db93d25f13f22c3647ec682f7d0c0b Mon Sep 17 00:00:00 2001
From: 魏曹先生 <1992414357@qq.com>
Date: Sat, 18 Oct 2025 18:24:09 +0800
Subject: docs: add documentation files

- Add project documentation
- Include usage guides and API references
---
 "docs/\346\236\204\346\203\263.md" | 73 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 73 insertions(+)
 create mode 100644 "docs/\346\236\204\346\203\263.md"

diff --git "a/docs/\346\236\204\346\203\263.md" "b/docs/\346\236\204\346\203\263.md"
new file mode 100644
index 0000000..4f20785
--- /dev/null
+++ "b/docs/\346\236\204\346\203\263.md"
@@ -0,0 +1,73 @@
+# 设置本地工作区（制定在该工作区操作的账户）
+jv init --user catilgrass
+jv create "MyLocalWorkspace" --user catilgrass
+
+# 设置库 （指定在该工作区使用的表）
+jv vault vault.catilgrass.cn --sheet unity
+jv vault test # 检查可连接性和自身权限
+
+# 拿取当前表的文件到本地
+jv fetch
+
+# 查看当前目录下的信息（所在库，使用账户，该目录的文件信息）
+jv here
+# 同理，可以查看树状
+jv here --tree
+
+# 跟踪未跟踪的文件
+jv track * # 此操作会询问是否上传文件
+jv track * --confirm 
+
+# 拿到文件的编辑权
+jv hold "本地表中的名称" # 当文件和上游不同步时，该操作会禁止你拿取，但是可以使用 --force 强制拿取（强烈不推荐，只有一种情况是还算可以容忍的，就是 “忘了拿取但是已经编辑，不过这期间没人修改”）
+jv throw "本地表中的名称" # 当文件被修改，却没有被保存时，该操作会禁止你丢弃，可以使用 --force 强制丢弃，同时可以使用 --restore 还原回编辑前的版本
+
+# 再次查看本地文件
+jv here --tracked
+
+# 当本地文件修改、移动、重命名后，记得自动跟踪下（以防断裂）
+jv track --auto
+# 或者，启动跟踪器
+jv-tracker --daemon
+
+# 修改完成后
+jv save # 保存至上游
+
+# 再次检查状态
+jv here
+
+# 拿取
+jv fetch
+
+# 如果想发送文件给别的表 （仅允许发送表中记录的）
+jv out Texture.png art # 可用于互换文件、申请建立参照
+
+# 查看传入的文件
+jv in
+
+# 接受、拒绝传入的文件
+jv in "发送者给出的参照名称" "存入的地址（不写默认为参照）" --accept # 不标记accept/deny则是提示存储后的结构
+jv ferch # 拿到刚刚传入的文件
+
+# 从其他表拿到文件
+jv in art@Art/Character.png "存入地址，默认为该文件在其他表的名字" # 此格式不需要显式的 接受、拒绝 标记
+# 直接从虚拟文件id拿到文件
+jv in vf_xxxxx "存入地址，默认为在参照表的名字（参照表不存在则直接使用 id）" # 此格式不需要显式的 接受、拒绝 标记
+
+
+# 切换本地表
+jv here --tree --modified # 先确认是否有没保存的文件
+jv switch "其他表" # 若该表不是自己的，则无法切换 
+jv switch "其他表" --force --confirm # 可以使用 force 强行切换至该表，但是你无法修改和操作其中任何东西，只读
+
+# 切换访问账户
+jv here # 查看当前账户
+jv account "peter" # 切换账户 （和强制switch一样，若权限对不上则只读）
+jv user account # 查看所有本地账户（会显示是否存放密钥）
+jv user account register "账户名称" # 在本地增加账户
+jv user account remove "账户名称" # 在本地移除账户
+jv user account default "账户名称" # 设置默认账户名称，在jv init 时则不需要显式制定
+
+
+注意！所有的表操作都是联网处理的，在没有网的情况下将无法进行任何表操作，唯一能做的只有编辑已经拿到锁的文件
+
-- 
cgit