通用选项参考 · BioSolveIT CLI

01 命令行约定

单字母短选项前缀一个连字符,如 -i;完整命名的长选项前缀两个连字符,如 --input。
需要参数(arg)的选项,等号可写可不写:-v 0 与 -v=0 等价。
根据操作系统调整路径写法:Linux/macOS 用 / 与 ./flexx,Windows 用 \ 与 .\flexx.exe(或在 PowerShell 中)。
本站示例统一用 ./ 前缀(类 Unix 写法);把可执行文件名替换成你系统上的实际名即可。

02 通用选项(General Options)

下面这些选项九个工具(及 CoLibri 的四个子工具)全部支持:

-h / --help

打印命令行帮助,列出每个选项的简短说明。括号里给出的是默认值。

--license-info

打印当前许可证设置:服务器机器规格、被搜索的目录、当前许可证有效性。启动异常时排错首选;给 support 发邮件时附上这段输出。

--version

打印版本号。引用工具时请带上该版本号。

--thread-count 默认=全部核心

用于计算的最大线程数。默认使用所有可用逻辑核心。想同时跑别的任务、或共用计算资源时可调小。
注:FragspaceMerger 与 FragspaceConverter 不涉及此项。

-v / --verbosity 默认=2

控制台输出级别(见下表)。

verbosity 级别

值	名称	含义
`0`	quiet / silent	不显示任何消息,尽量忽略错误。
`1`	error	只显示错误消息。
`2`	warning(默认)	显示警告与错误。
`3`	info / workflow	额外显示步骤/流程信息。
`4`	steps	在 info 基础上详细显示每步进度。

小差异

对接/构象类工具(FlexX、HYDE、FastGrow、FlexS、Conformator)把级别 0 称为 quiet、级别 3 称为 info;化学空间类工具(FTrees、SpaceLight、SpaceMACS、CoLibri)把级别 0 称为 silent、级别 3 称为 workflow。含义一致。

通用选项示例(以 flexx 为例,其余工具同理)

./flexx --help            # 查看所有选项与默认值
./flexx --version         # 查看版本号
./flexx --license-info    # 查看/排查许可证
./flexx --thread-count 4   # 限制为 4 线程
./flexx -v 0               # 静默运行

03 授权(Licensing)

所有工具都需要有效许可证才能运行。常见做法:把在线申请到的"测试许可证"文件直接放在可执行文件旁边。

工具	SeeSAR 许可证是否可用
FlexX / HYDE / FastGrow / FlexS / Conformator	✅ 有效的 SeeSAR 许可证会被接受
FTrees / SpaceLight / SpaceMACS / CoLibri	需要相应许可证(测试许可证放在可执行文件旁)
FastGrowDBCreator	❌ 需要单独许可证,SeeSAR 许可证不适用

macOS 特别说明

在 macOS 上,可执行文件通常位于 .app 包内,例如 /Applications/FlexX.app/Contents/MacOS/FlexX。在 Finder 里右键点 .app →「显示包内容」即可进入 Contents/MacOS/,把测试许可证放在可执行文件旁。首次运行需在 Finder 中对 .app 右键「打开」并确认一次,之后即可在终端正常使用。

没有许可证?

通过各工具 --license-info 输出底部的链接在线申请评估/长期许可证;长期许可证会单独处理。

04 跨工具的文件格式

类别	常见格式	说明
小分子 / 配体	`.sdf .mol .mol2`	对接/打分/叠合需含 3D 坐标,否则被跳过。
SMILES 输入	`.smi .smiles` 或引号串	逐行 SMILES 文件,或直接 `-i "CC(C)C(=O)N"`。Conformator 与化学空间类工具支持。
蛋白	`.pdb .ent .cif .mcif .mmcif`	FlexX/HYDE/FastGrow 用;FlexX 也支持 DNA/RNA。
SeeSAR 导出定义	`.flexx .hydescorer .fastgrow .flexs`	各含蛋白、预定义位点与(可选)药效团约束,替代"蛋白+参考配体"两件套。
化学空间	`.space`	可被 FTrees / SpaceLight / SpaceMACS 检索;由 CoLibri 生成或官网下载。
搜索结果	`.csv .sdf`	化学空间类工具:`-o` 每查询一个文件;`-O` 合并为单文件。

05 化学空间检索三件套的共性

FTrees、SpaceLight、SpaceMACS 三者命令行接口高度一致:

-i 查询(文件或 SMILES,可多次)、-s 检索对象(.space 或库,可多次、可混用)。
-o 每查询一个输出文件;-O 所有查询合并为单个输出文件;-m 为每个命中生成匹配图(增加运行时间)。
--max-nof-results(默认 100)、--expand-alternative-results(展开同一命中的其他反应路径)。
不指定输出文件时,结果默认打印到控制台(STDOUT)。

性能:把 .space 放本地磁盘

首次搜索某个 .space 时会缓存到本地 tmp,之后即与本地文件同速。可改缓存目录:
Linux / macOS(bash):export TMPDIR=/path/to/folder
Windows(PowerShell):$Env:TMP="C:\path\to\folder"