命令说明
将本地文件、文件夹、URL 或仓库导入到 OpenViking。
语法
ov add-resource <path-or-url> [options]
参数说明
参数 | 必填 | 说明 |
|---|
<path-or-url>
| 是 | 要导入的本地路径、URL 或仓库
不传默认导入至 user 目录下的 resources 目录 |
常用选项
参数 | 必填 | 说明 |
|---|
--parent <uri>
| 否 | 导入到一个已存在的目录 URI 下 |
-p, --parent-auto-create <uri>
| 否 | 如果父目录不存在则创建。不能与 --to 或 --parent 同时使用 |
--to <uri>
| 否 | 导入到一个精确的新资源 URI。不能与 --parent 同时使用 |
--include <patterns>
| 否 | 文件夹导入时只包含指定扩展名,例如 --include "*.md,*.pdf" |
--exclude <patterns>
| 否 | 文件夹导入时排除指定扩展名,例如 --exclude "*.tmp,*.log" |
高级选项
参数 | 必填 | 说明 | 默认值 |
|---|
--reason <text>
| 否 | 附加导入原因 | 空 |
--instruction <text>
| 否 | 附加处理说明 | 空 |
--watch-interval <minutes>
| 否 | 设置自动刷新间隔(0 = 不监控) | 0
|
--progress
| 否 | 显示本地上传进度(覆盖配置) | |
--no-progress
| 否 | 不显示本地上传进度(覆盖配置) | |
-v, --verbose
| 否 | 打印上传诊断信息 | |
args.feishu_access_token
| 是 | 上传飞书文档必填, user_access_token,获取方式见 上传飞书文档
OpenViking 使用该 Token 以用户身份读取飞书文档。 | |
args.feishu_refresh_token
| 否 | 上传飞书文档, refresh_token,获取方式见 上传飞书文档
仅定时同步场景需要传入。
一次性导入不建议传入,避免扩大敏感凭证保存范围。 | |
args.stream
| 是 | 上传飞书项目必填,待上传的文件类型
需求:feishu_project_stories
缺陷:feishu_project_issues | |
args.project_keys
| 是 | 上传飞书项目必填,所属空间
 | |
args.user_key
| 是 | 上传飞书项目必填,飞书项目用户 ID,获取方式见 上传飞书项目 | |
args.branch
| 否 | 上传代码仓库,默认使用默认分支
指定导入分支,例如 main | 默认分支 |
args.ref
| 否 | 上传代码仓库
branch 的别名;同时提供时 branch 优先 | |
args.commit
| 否 | 上传代码仓库
固定到指定 Commit,优先级高于分支 | |
args.auth_config
| 否 | 上传代码仓库
私有 HTTPS 仓库认证配置 | |
args.auth_config.username
| 否 | 上传代码仓库,默认oauth2
HTTPS Basic Auth 用户名 | oauth2
|
args.auth_config.token
| 是 | 上传私有代码仓库必填,获取方式见 上传代码仓库
Git PAT 或 Deploy Token | |
args.parse_mode
| 否 | 上传代码仓库,默认default
通用解析模式,代码仓库通常保持默认 | default
|
args.cloud_id
| 是 | 上传Confluence文档必填
源 Confluence 站点的 Cloud ID。可以在浏览器打开网址,查找该参数。同一个站点可以复用,不需要每次导入都获取。 | |
args.resources[].type
| 是 | 上传Confluence文档必填
支持 page、folder、space。 | |
args.resources[].id
| 是 | 上传Confluence文档必填
从 Confluence 链接中获取:页面填 /pages/ 后的数字,文件夹填 /folder/ 后的数字,整空间填 /spaces/ 后的 space key,type 分别填 page、folder、space,所有 id 都按字符串传入。 | |
args.auth_config.email
| 是 | 上传Confluence文档必填
源 Atlassian 账号邮箱。 | |
args.auth_config.api_token
| 是 | 上传Confluence文档必填
该账号的 Confluence API token。 | |
args.auth_config.api_token_scope
| 否 | 上传Confluence文档
若非 scoped API token 使用 unscoped。 | scoped
|
使用示例
1. 导入一个文件夹并等待处理完成
ov add-resource ./docs --parent viking://<YOUR_PROJECT_NAME>
2. 导入一个 URL 到精确的目标 URI
ov add-resource https://example.com/spec.md --to viking://specs/api.md
下一步
导入后,可以用以下命令查看进度或浏览:
# 查看异步处理任务
ov task list
# 检索导入的上下文
ov find "<YOUR_QUERY>"
# 浏览导入后的资源结构
ov tree <uri>
参数、示例与排错补充
- 需替换的示例值未明确标识:代码和命令中的
<...> 均为占位符,运行前必须替换为当前账号、项目或资源的真实值;名称从控制台/列表查询确认,ID/URI 从创建、导入或查询响应复制。 - 指令不具体 - 代码/命令行操作:示例中的
<...> 为必须替换的占位符:URI 从创建/导入或列表、搜索结果中复制,ID 从对应创建/列表命令获取,查询词替换为实际业务输入;命令执行成功后再继续“下一步”。