5.2 fkit 基础操作
5.2.1 登录与认证
fkit 是 BioLine 连接 BioLine 的唯一事实来源。登录需要 AccessKey 与 AccessSecret,其只作为 fkit login 的命令行参数使用,不写入仓库、Job 目录或参数覆盖文件。推荐使用 fkit flow list --limit 1 --json 做非交互登录检查。
提醒:请勿将裸 fkit project 当作自动化探针,因为它会进入交互式项目选择器,在非 TTY shell 中可能产生乱码并干扰诊断。
5.2.2 文件管理
fkit 在用户侧最常见的工作包括以下几类。
- 用 fkit upload 把本地数据放到 BioLine 路径中。
- 用 fkit ls 查看 BioLine 路径下有哪些文件。
- 用 fkit download 把需要的结果或非测序文件拉到本地。
BioLine 路径类型包括。
- /Store/...
- /personal/<user>/...
- /open/...
5.2.3 Flow 查询与任务提交
在正式提交前,系统会通过 fkit 去了解用户将要运行的 flow。
- fkit flow list 用于根据关键字查找 flow。
- fkit flow inspect 用于查看 flow 的输入、参数和版本细节。
- fkit job create 用于提交真实任务。
- fkit job list、fkit job search 和 fkit job get 用于查看任务状态。
5.2.4 fkit Tool 检查与更新
先用 fkit update NAME 检查正整数版本、下一版本号和可用模式,再明确选择更新模式。fkit 不在本地扫描 Flow 引用。原位更新必须指定 NAME:VERSION;若 BioLine 服务端发现该版本仍被 Flow 引用,会拒绝修改,fkit 原样呈现该错误,不重试也不另建版本。
示例:
fkit update NAME
fkit update NAME:VERSION --mode in-place --config tool.json --dry-run
fkit update NAME --mode new-version --dry-run --json
new-version 复用基线版本已存放在服务端的镜像(fkit 自动读取基线的 path,不再上传本地镜像),以单次请求创建 max+1 版本,并验证版本列表恰好新增了预期的正整数版本。--config 只写要改的字段,会合并进基线配置并校验命令;--summary 是全量摘要文本,省略时沿用基线摘要(基线摘要为空则拒绝创建)。创建请求本身就携带命令与摘要,所以正常只需一次写入;创建后 fkit 读回该版本核对,若服务端没有保留请求体里的配置,才对这个刚创建的版本补发一次 update,绝不多写也不循环。--dry-run 只做本地与只读校验,不提交远端修改;--json 输出检查或操作状态,其中 configSource 说明配置来自创建请求还是补发的 update,remoteWriteCalls 给出实际写入次数(正常为 1)。
