Spectronaut命令行

Spectronaut 命令行模式概述

Spectronaut 支持在 Windows（使用 cmd 或 Powershell）和 Linux 操作系统下以命令行模式运行。获取可用命令和选项的总览，请运行：

spectronaut -h

其中在 Windows 下可使用命令：

dotnet Spectronaut.dll

在 Linux 下直接使用可执行文件 **spectronaut**。

此外，还支持以下操作：

• 激活许可证

  spectronaut activate <参数>
  

• 停用许可证

  spectronaut deactivate
  

• Ubuntu Linux 安装

  sudo dpkg -i spectronaut-VER.deb
  

 其中 “VER” 表示要安装的 Spectronaut 版本。  

• 对于其他 Linux 发行版，请参阅附带 tarball 安装包中的 README 文件。

Spectronaut pipelines 可通过以下命令调用：

• • lg**, **diaanalysis**, **direct**, **convert**, **combine**, **manageSNE**。

使用 “spectronaut -h” 可查看所选命令的详细说明。

库生成（Library Generation）

生成谱库时，需调用命令 **spectronaut lg**。不同搜索引擎下的参数有所区别，下面分别说明。

基于 Pulsar 的谱库生成

使用 Pulsar 搜索引擎生成谱库时，命令行以：

lg -se Pulsar

开头，后续可使用下列参数配置实验。下表整理了各参数的说明：

参数	说明
**-se Pulsar**	必须作为第一个命令参数，用于调用基于 Pulsar 的库生成流程。
**-r [文件路径]**	添加一个原始数据文件到实验中。支持的文件格式包括：*.raw、*.wiff、*.bgms、_HEADER.TXT、analysis.baf。此命令可多次使用以添加多个文件。
**-d [目录路径]**	添加指定目录中所有 Spectronaut 能识别的原始文件。该选项会包括已作为文件夹存在的厂商文件（如 Bruker 的 .d 文件夹、Waters 的 run 文件夹）。可多次使用。
**-sa [文件路径] (可选)**	向库生成实验中添加一个特定的 Search Archive（*.psar 文件）。可多次使用以添加多个文件。默认的 Search Archive 存储位置配置在：Settings Perspective > Global > Directories。
**-sad [目录路径] (可选)**	向实验中添加指定目录下所有的 Search Archive（*.psar 文件）。
**-fasta [文件路径]**	指定用于 DDA 搜索空间的 *.bgsfasta（Managed FASTA）文件，该文件中包含了解析规则。可多次使用以添加多个文件。默认位置配置在：Settings Perspective > Global > Directories。
**-rs [文件路径] 或 -rs [schema-name] (可选)**	指定本次搜索所使用的 Pulsar 搜索 Schema。如果未指定，则使用默认 Schema。可传入一个 schema 文件（*.prop）路径，或直接给出一个 Schema 名称（该名称需要位于 Spectronaut 内部的搜索 Schema 库中）。
**-es [文件路径] 或 -es [schema-name] (可选)**	指定本次搜索所使用的库生成 Schema。如果未指定，则使用默认 Schema。用法同上，可传入 schema 文件（*.prop）路径或 Schema 名称（该名称需要位于 Spectronaut 内部的库生成 Schema 库中）。
**-a [文件路径] (可选)**	指定生成的 Search Archive 文件的存放位置。如果不提供，则会存储在默认位置（配置在：Settings Perspective > Global > Directories）。
**-k [文件路径] (可选)**	指定生成的谱库文件的存放位置。如果不提供，则会存储在默认位置（配置在：Settings Perspective > Global > Directories）。
**-regex [正则表达式] (可选)**	将正则表达式作为过滤器应用于 **-d** 命令，筛选文件。
**-n [任意文本] (可选)**	指定本次搜索的实验名称，用于标记生成的谱库和 Search Archive。如果不提供，Spectronaut 会根据运行文件名自动生成实验名称。
**-inf [文件路径] (可选)**	指定用于蛋白质推断的 *.bgsfasta（Managed FASTA）文件路径。默认情况下，搜索空间中指定的 FASTA 文件也将用于蛋白质推断。可多次使用以添加多个文件。默认位置配置在：Settings Perspective > Global > Directories。
**-go [文件路径]**	指定基因注释文件的路径（可多次使用以添加多个文件）。

基于外部搜索引擎的谱库生成

如果使用外部搜索引擎进行谱库生成，使用以下参数（参见下表）：

参数	说明
**-lg -se <Engine>**	必须作为第一个命令参数，用于调用基于外部搜索引擎的库生成流程。<Engine> 替换为以下选项之一：ProteomeDiscoverer、MaxQuant、ProteinPilot、BGSGenericSearchFormat 或 Mascot。
**-sr [搜索结果文件路径]**	指定搜索结果文件的路径。具体要求请参照各搜索引擎对应的说明，了解所需的搜索结果类型。
**-rd [原始文件路径]**	指定原始运行文件所在的路径。
**-o [输出库文件]**	指定生成的谱库文件的输出位置和文件名。
**-s [文件路径] (可选)**	指定用于本次搜索结果的库生成 Schema。如果不指定，则使用默认 Schema。要求传入 schema 文件（*.prop）。
**-fasta [文件路径] (可选)**	指定用于蛋白质推断的 *.bgsfasta（Managed FASTA）文件路径。默认位置配置在：Settings Perspective > Global > Directories。

Spectronaut 分析（Analysis）

Spectronaut 分析支持两种模式：

• 基于预编译谱库或 Search Archive 的 DIA 分析：使用命令 **spectronaut diaanalysis**
• 基于库自由（DirectDIA）搜索模式：使用命令 **spectronaut direct**

后续可使用以下参数配置实验：

参数	说明
**-h**	显示帮助窗口，说明 Spectronaut 实验的基本运行命令。
**-r [文件路径]**	添加单个运行文件到实验中。支持的文件格式包括：*.htrms、*.raw、*.wiff、*.bgms、_HEADER.TXT、analysis.baf。可多次使用。
**-d [目录路径]**	添加指定目录中所有 Spectronaut 能识别的运行文件。包括已作为文件夹存在的厂商文件（例如 Bruker 的 .d 文件夹、Waters 的 .raw 文件夹）。
**-regex [正则表达式] (可选)**	对 **-d** 命令添加的文件应用正则表达式过滤器。
**-a [文件路径]**	为实验中所有运行文件指定一个谱库文件。可多次使用以添加多个文件。
**-ar [文件路径]**	为上一个通过 **-r** 命令添加的运行文件指定一个谱库文件。可多次使用。
**-s [文件路径] 或 -s [schema-name] (可选)**	指定用于分析的设置 Schema。如果不指定，则使用默认设置。可传入 schema 文件（*.prop）路径，也可以直接给出 Schema 名称（前提是该 Schema 位于默认位置）。
**-rs [schema 文件路径] (可选)**	指定报告（report） Schema。
**-o [目录路径] (可选)**	指定实验的输出目录。所有生成的报告会存放在一个以分析日期和实验名称命名的子文件夹中。 Windows 默认：用户在全局设置中指定的默认输出目录或 `%Appdata%\Spectronaut\Results`（若未指定）。 Linux 默认：当前目录。
**-n [任意文本] (可选)**	指定实验名称。如果不指定，Spectronaut 会自动根据运行文件名称生成实验名称。
**-fasta [文件路径] (可选)**	指定用于本次实验的 *.fasta 或 *.bgsfasta 文件，用于蛋白质推断。在库（peptide-centric）分析中，此文件必不可少，尤其在使用 **-direct** 模式时。可多次使用。
**-go [文件路径] (可选)**	指定用于附加的 Gene Ontology (GO) 注释文件。可多次使用。
**-con [文件路径] (可选)**	指定用于后处理（如调控分析）的条件设置文件。建议通过 Spectronaut 图形界面生成后导出使用。如果不使用，Spectronaut 会根据运行文件名的解析策略自动推导样品条件。
**-command [文件路径] (可选)**	指定一个命令或参数文件，替代标准的命令行参数。该参数必须作为第一个命令出现，之后的其他命令将被忽略。文件内采用逐行读取方式，格式与常规命令行参数相同。可从实验设置向导的最后一页导出示例。
**-rExt [文件路径]**	为 1 步混合（hybrid）基于库的 DIA 分析添加单个运行文件。支持的文件格式同上。可多次使用。
**-dExt [目录路径]**	为 1 步混合基于库的 DIA 分析添加指定目录中所有 Spectronaut 能识别的运行文件。
**-sne**	从 .sne 文件加载实验。
**-j [文件路径]**	指定一个 .json 文件，用于覆盖默认设置和实现灵活的 pipeline 集成。

示例命令：

dotnet Spectronaut.dll –d "C:\data\My Experiment" –a "C:\data\My Experiment\library.txt" –s "my_settings" –o "C:\data\My Experiment\Results" –n "My Experiment 1" –f ".*\.wiff"

• 提示：如果自动解析谱库时出现问题，请先使用 Spectronaut 图形界面加载谱库，确认所有必要列均被正确识别。*

合并 SNE 文件

要在命令行模式下执行 SNE 合并流程，请使用命令：

spectronaut combine

后面可跟如下选项：

参数	说明
**-s**	选择要使用的设置 Schema 文件的路径。
**-n**	指定实验名称。
**-fasta**	指定用于蛋白质推断的 *.fasta 或 *.bgsfasta 文件的路径。
**-sne**	指定要合并的 .sne 文件。可多次使用以添加多个文件。
**-d**	指定包含要合并的 .sne 文件的目录。可多次使用以添加多个目录。
**-o (必选)**	指定结果存放的目录。
**-rs**	指定自定义报告 Schema。

管理 SNE 文件

Spectronaut 命令行支持加载 .sne 文件生成报告，并可通过 **--merge** 选项将多个 .sne 文件在实验层面合并，效果等同于同时运行这些文件。可用选项如下：

参数	说明
**-sne**	选择需要加载的 .sne 文件。
**-n**	指定实验名称。
**-d**	指定包含要加载的 .sne 文件的目录。可多次使用。
**-o (必选)**	指定结果输出的目录。
**-rs**	指定自定义报告 Schema。
**--merge**	如果指定此选项，并且提供了多个 .sne 文件，则会在实验层面合并为一个 Spectronaut 实验，并保存为新的 .sne 文件。 警告：对于大型实验，该操作可能会占用大量磁盘空间和内存。建议使用 **combine** 命令生成合并报告。
**--skip-loading**	不加载和处理 Spectronaut 实验。可用于快速检查 Spectronaut 版本兼容性或仅用于解锁 .sne 文件。
**--unlock**	如果 .sne 文件是在 Bruker ProteoScape 环境中创建，此选项可将其解锁，以便其他用户共享。可与 **--skip-loading** 一起用于批量解锁。

其他选项

除了运行命令外，Spectronaut 还支持其他操作，这些操作可单独执行，也可与命令组合使用（如果与命令组合，需将这些选项置于命令前面）。

例如：

dotnet Spectronaut.dll --noXICDump

该命令会永久关闭 XIC 导出功能，直到使用 **--setXICExportDirectory** 恢复。

下列为其他可用选项：

参数	说明
**-setTemp**	指定 Spectronaut 的临时目录。
**--version**	显示 Spectronaut 版本信息后退出。
**--exportModRepository**	将 modification 库导出到指定文件。
**--importModRepository**	从指定文件导入 modification 库。 警告：将覆盖当前的 modification repository。
**--exportEnzymeDB**	将酶数据库导出到指定文件。
**--importEnzymeDB**	从指定文件导入酶数据库。 警告：如遇酶名称冲突，现有记录将被覆盖。
**--noXICDump**	关闭自动 XIC 导出。
**--setXICExportDirectory [目录路径]**	开启自动将所有 XIC 以 SQL 数据库文件形式存储，并将文件存入指定目录。

退出代码

为了便于在脚本或其他 pipeline 中使用，Spectronaut 命令行执行完毕后会以不同错误代码退出。主要分组说明如下：

• 成功：

 * 代码 **0**：成功。

• 激活相关错误（代码 1-9）：

 * 1：激活错误  
 * 2：停用错误  
 * 3：许可证不足  
 * 4：当前许可证或软件版本活动不足  
 * ……

• 设置错误（代码 11-19）：

 * 11：命令行调用不正确  
 * ……

• 后续阶段错误（代码 ≥20）：

 * 任何代码大于或等于 20 的错误。

另外，还可以从 Spectronaut 实验设置向导的最后一页导出 Windows 命令行设置，用于 DIA 分析。