终端命令行
简介
在个性化终端中通过SDK与云平台交互，解决数据检索、流程注册、任务投递及管理中的效率问题，支持镜像管理、批量操作等功能。
使用方式：开启个性分析在线任务，进入terminal终端默认已安装并可使用SDK工具包，当环境中无法使用工具包时，请检查镜像环境是否设置特殊权限限制了系统自动安装，可通过以下命令自行安装
# 安装
cd ~
rm -rf dcs_cli-main.zip dcs_cli-main
cp /dcs-sdk-soft/dcs_cli-main.zip ~
unzip dcs_cli-main.zip
cd dcs_cli-main
pip install -e .
所有命令支持 --help 查看详细帮助（如 dcs image ls --help）
通过命令管理数据
帮助（dcs data --help）
dcs data --help #数据管理所有命令支持--help查看详细帮助
上传文件
通过命令将notebook work目录的文件上传至数据管理-文件页面。语法如下：
dcs data push [本地work目录下的路径...] [云平台路径]
[work目录路径 ...]：要上传的当前workspace下的本地文件或目录，批量文件或目录用逗号隔开
[云平台路径]：云平台中的目标目录，以/Files开头
注意：同一文件夹内不能重名，文件名称只能含有中文字符、英文字符、数字、"_"、"."、"-"、"("、")"、"@"，不支持上传jsp、asp、php、aspx、html等程序文件。
示例场景
将本地文件夹/data/work/test/test.txt文件上传至云平台当前项目/Files/zhangsan目录下
dcs data push /data/work/test/test.txt /Files/zhangsan
上传下载表格
通过命令将notebook work目录的文件上传至数据管理-表格，或将表格下载到work目录。语法如下：
dcs data push -tb [本地work目录文件路径] 云平台表格名称
dcs data pull -tb [云平台表格名称] [本地work路径] #长参数--table
[本地work目录文件路径]：要上传到云平台的表格，以文件后缀结尾，一次只能上传一个表格
[表格名称]：上传到云平台后表格的名称，表格名称为100个字节以内的字母、数字、"_"、"-"和"."，且不能重复
[本地work路径]：存放表格文件的路径
示例场景
将表格test下载到本地work目录
dcs data pull -tb test /data/work 或 dcs data pull --table test /data/work
文件查询 (dcs data find)
递归搜索文件或目录，支持多条件过滤。命令如下：
dcs data find [路径] [选项] #支持--help查看详细信息
[路径]：指要搜索的云平台数据管理目录路径，/Files开头。
[选项]：支持通配符和多条件组合过滤。
选项说明：
| 选项（短参数） | 长参数 | 参数格式 | 作用 | 示例 |
|---|---|---|---|---|
-t <类型> | --type | f（文件）或 d（目录） | 按类型过滤 | dcs data find /Files -t f |
-n <名称> | --name | 英文逗号分隔的名称列表（支持*和?） | 按名称匹配 | dcs data find /Files -n "*.fq.gz" |
-s <大小> | --size | +/-<数值> | 按大小过滤 | dcs data find /Files -s +100MB |
--entity <ID> | 英文逗号分隔的实体ID | 按实体ID过滤 | dcs data find /Files/sdk_stacy --entity D17BC0001301,D17BC0001302 | |
--sample <ID> | 英文逗号分隔的样本ID | 按样本ID过滤 | dcs data find /Files/sdk_stacy --sample S0001,S0003 | |
--sn <SN> | 英文逗号分隔的SN编号 | 按SN编号过滤 | dcs data find /Files/sdk_stacy --sn D02671D6,D024513 | |
--task <ID> | 英文逗号分隔的任务ID | 按任务ID过滤 | dcs data find /Files/sdk_stacy --task W202405100172 | |
--workflow <名称> | 流程名称,版本 | 按流程名称和版本过滤 | dcs data find /Files/sdk_stacy --workflow Copy-WGS-zbolt-fpga,1.2.0 | |
-u <用户> | --user | 逗号分隔的用户名 | 按创建者过滤 | dcs data find /Files/sdk_stacy -u cuihuihai |
--time <时间> | YYYY/MM/DD~YYYY/MM/DD 或单日期 | 按创建时间过滤 | dcs data find /Files/sdk_stacy --time 2025/01/01~2025/01/31 | |
| -a | --all | 查询并返回所有数据（不翻页） | dcs data find /Files/sdk_stacy -a | |
| -o | --output | 导出查询结果到指定路径，默认前10条 | dcs data find /Files/sdk_stacy -a -o /data/work/433.txt |
示例场景
查找2025年1月创建的超过100MB的vcf文件
dcs data find /Files/ResultData -n "*.vcf.gz" -s +100M --time 2025/01/01~2025/01/31
目录列表 (dcs data ls)
列出目录内容，支持排序和表格查询。命令如下：
dcs data ls [选项] [路径]
[选项]：用于控制 ls 命令的行为，例如显示详细信息。
[路径]：指定要列出的文件或目录。如果未指定，则默认列出当前目录的内容，如dcs data ls。
注意：暂不支持通配符。
选项说明：
| 选项（短参数） | 长参数 | 作用 | 示例 |
|---|---|---|---|
| -l | 显示详细信息（大小、创建时间等） | dcs data ls -l | |
| -t | 按创建时间降序排序，默认情况下是从最近修改的文件开始排序 | dcs data ls -l -t | |
| -S | 按文件大小排序，默认降序 加-r 则为升序 | dcs data ls -l -S /Files/sdk_stacy（降序） dcs data ls -l -S -r /Files/sdk_stacy（升序） | |
| -h | --human-readable | 把文件大小转为方便阅读的方式（参考页面转为GB或MB等） | dcs data ls -l -h |
| -tb | --table | 列出所有表格 | dcs data ls -tb |
| -a | --all | 查询并返回所有数据（不翻页） | dcs data ls -a /Files/sdk_stacy |
| -o | --output | 导出查询结果到指定路径，默认前10条 | dcs data ls -a -o /data/work/123456.txt /Files/sdk_stacy |
查看元数据信息（dcs data info）
查看文件或目录的详细信息，语法为：
dcs data info [路径或文件名] # 查看文件/目录元数据，若只填的文件名，这默认为当前目录下的文件
示例场景
查看V350099495_L04_read_2.fq.gz文件详细信息
dcs data info /Files/RawData/V350099495_L04_read_2.fq.gz
目录切换 (dcs data cd)
切换当前工作目录，语法为：
dcs data cd [路径] #路径可以是：绝对路径（从根目录开始，例如 /Files/ResultData。相对路径（基于当前工作目录，例如 ../Workflow）。特殊符号（例如 . 表示当前目录，.. 表示上一级目录，~ 表示主目录）
删除文件（dcs data rm）
删除有权限的目录或文件，语法为：
dcs data rm [路径或文件名] # 删除目录（包含子文件），批量删除英文逗号隔开，系统文件夹不允许删除.若只填的文件名，这默认为当前目录下的文件
注意：文件删除后无法被找回，请谨慎操作此命令。
通过命令管理镜像
通过命令实现镜像的查询、查看详情操作
查询镜像列表
查询个人或者公共库的镜像列表，命令如下：
dcs image ls [选项]
[选项]：通过镜像名称、镜像url等条件查询镜像列表，命令不接选项时，默认查询个人所有镜像列表，默认展示10条，返回形式如下：
命令选项参数说明
| 短参数 | 长参数 | 参数格式 | 参数定义 | 示例 |
|---|---|---|---|---|
| -u | --url | 云平台镜像url地址 | 查询指定url的镜像 | dcs image ls -url stereonote/stereonote_non_conda_git:latest |
| -n | --name | 云平台镜像名称 | 查询指定名称的镜像，支持模糊查询 | dcs image ls -n stereonote-code-basic |
| -p | --public | - | 查询公共库的镜像 | dcs image ls -p |
| -a | --all | - | 查询并返回所有镜像列表 | dcs image ls -a |
| -o | --output | 本地/data/work路径 | 输出文件路径，指定全路径如/data/work/A.txt，则在work目录下生成名为A的文件；指定目录如/data/work/，则在work目录下生成系统命名的文件，如image_202503251636.txt | dcs image ls -o /data/work/A.txt |
查看镜像详情
查询云平台上指定镜像详细信息，命令如下
dcs image info [选项]
[选项]：通过镜像名称、镜像url查询指定镜像的详细信，需补充-n或-u其中一个参数
命令选项参数说明
| 短参数 | 长参数 | 参数格式 | 参数定义 | 示例 |
|---|---|---|---|---|
| -n | --name | 云平台镜像url地址 | 查询指定名称镜像的详细信息 | dcs image ls -url stereonote/stereonote_non_conda_git:latest |
| -u | --url | 云平台镜像名称 | 查询指定url镜像的详细信息 | dcs image ls -n stereonote-code-basic |
| -p | --public | - | 查询公共库镜像的详情信息 | dcs image ls -p |
示例：查询镜像名称为“stereonote-code-basic”的详细信息
dcs image info --name stereonote-code-basic
返回如下：
通过命令管理工作流
查询工作流列表
通过命令查询项目内或公共库的流程列表,，命令如下
dcs app ls [选项]
[选项]：通过流程名称、创建人、tag查询工作流，不接选项时，默认查询项目下的流程列表，默认返回10条
命令选项参数说明
| 短参数 | 长参数 | 参数格式 | 参数定义 | 示例 |
|---|---|---|---|---|
| -n | --name | 流程名称 | 按流程名称查询workflow工具，支持模糊查询 | dsc app ls -n SAW-ST-V7 |
| -u | --user | 云平台用户名 | 按流程创建者查询workflow工具，支持模糊查询 | dsc app ls -u zhangsan |
| -p | --public | - | 查询公共库的workflow工具 | dsc app ls --public |
| -t | --tag | 流程标签，多个用英文逗号分隔 | 按流程标签查询workflow工具，多个标签使用“,”分割 | dsc app ls --tag Genomics,Epigenomics |
| -a | --all | - | 查询并返回所有工具列表 | dsc app ls -a |
| -o | --output | 本地/data/work路径 | 输出文件路径，指定全路径如data/work/A.txt，则在work目录下生成名为A的文件；指定目录如data/work/，则在work目录下生成系统命名的文件 | dsc app ls -o /data/work/A.txt |
示例：查询创建人为“liuqing1”，流程名称包含SAW-ST-V8的流程
dcs app ls -u liuqing1 -n SAW-ST-V8
返回如下：
创建\上传工作流
通过命令上传本地work目录下的工作流到云平台流程分析，命令如下
dcs app push -p [路径]
[路径]：本地环境work目录下的文件地址，工具需按照以下目录规则打包到压缩包中 ：
/data/work/hello.zip /
├── hello.yaml # 工作流基本信息文件
├── hello.wdl # WDL脚本主文件
└── my\_workflow.tar # WDL工作流依赖工具包（如有依赖包）
注意：当上传的工作流与项目已有的工作流重名时，可选择覆盖工作流或者生成工作流副本
示例：将/Data/work/下的export工作流上传到云平台，命令如下：
dcs app push -p ‘/data/work/workflow_export(14).zip’
返回如下：
注意：路径中包含（）符号，路径需加''
校验WDL语法是否正确
通过命令校验当前环境下WDL脚本文件语法是否符合云平台的校验规则，命令如下：
dcs app validate-p [路径]
[路径]：本地环境work目录下的文件地址，如/data/work/hello.wdl，仅支持.wdl格式文件
查询工作流详情
通过命令查询工作流的详细信息，命令如下
dcs app info -n [流程名称]
[流程名称] :指定要查询的工作流名称
命令选项参数说明
| 短参数 | 长参数 | 参数格式 | 参数定义 | 示例 |
|---|---|---|---|---|
| --public | - | 查询公共库工作流的详情信息 | dcs app info --public -n Copy-SAW-ST-V8 | |
| -v | --version | 工作流三位版本，如1.2.3 | 查询指定版本的工作流详情，默认最新版本 | dcs app info -n Copy-SAW-ST-V8 -v 1.1.3 |
示例：查询名称为Copy-SAW-ST-V8、版本为1.1.3的工作流详情，命令如下：
dcs app info -n Copy-SAW-ST-V8 -v 1.1.3
返回如下：
拉取\复制工作流
通过命令将项目或公共库中的工作流拉取到终端中，命令如下
dcs app pull -n [工作流名称] [选项]
[工作流名称] ：指定要拉取的工作流名称
[选项]：通过指定版本或者从公共库中拉取
命令选项参数说明
| 短参数 | 长参数 | 参数格式 | 参数定义 | 示例 |
|---|---|---|---|---|
| -v | --version | 工作流三位版本，如1.2.3 | 指定拉取的工具版本，与-n、-p参数一同使用 | dcs app pull -n Copy-SAW-ST-V8 -v 1.1.3 -p /data/work |
| -p | --path | 本地work目录下的路径 | 拉取的工具到终端的目标路径，默认为【当前路径】， | dcs app pull -n Copy-SAW-ST-V8 -v 1.1.3 -p /data/work |
| --public | - | 从公共库复制到项目并拉取到终端中，与-n、-p参数一同使用 | dcs app pull --public -n Copy-SAW-ST-V8 -p /data/work |
示例：将名称为”Copy-SAW-ST-V8“，版本为”1.1.3“的工作流拉取到”/data/work“目录下，命令如下
dcs app pull -n Copy-SAW-ST-V8 -v 1.1.3 -p /data/work
返回如下：
并在目标work目录下增加一个文件
更新工作流
使用命令更新项目内工作流，执行后获取关联的最新工作流覆盖当前工作流，命令如下
dcs app update -n [工作流名称]
[工作流名称]：指定要更新的工作流名称，若不指定将会返回项目中可更新的工作流列表
示例：查看项目中可更新的工作流，然后指定工作流更新
投递\运行工作流或脚本
运行workflow任务
通过命令投递workflow的单个或批量任务，支持通过-i-J--table三种形式传递流程参数投递任务
通过-i传入参数 ，命令如下：
dcs task run -n [工作流名称] -e[EntityID] -i [para=value取值键值对] [选项]
[工作流名称]：指定要运行的工作流名称
[EntityID] ：投递任务时的实体ID，通过-i传入时，-e参数必填
[para=value取值键值对]：传入参数及对应的取值，多个参数以多个-i传入，当参数为数组形式，需以json形式填写传入
命令选项参数说明
| 短参数 | 长参数 | 参数格式 | 参数定义 | 示例 |
|---|---|---|---|---|
| -t | --type | 默认w（workflow）、s（shell） | 运行任务的脚本类型，type的值有w（workflow）、s（shell），默认为w | dcs task run -n Hellodemo -e C04138G3 -i Fastqs_file=[["/Files/SN1_read1.fq.gz","/Files/SN1_read2.fq.gz"],["/Files/SN2_read1.fq.gz","/Files/SN2_read2.fq.gz"]] -i Image_file=/Files/C04138G3/image/C04138G3.tar.gz -i Mem=90 |
| -v | --version | 三位流程版本，如1.2.3 | 当运行任务脚本类型为workflow时，指定运行流程的版本，默认为最新版本 | |
| -o | --output | 数据管理路径，以'/Files/'路径开头 | 指定任务结果文件输出到数据管理的路径下，默认输出到/Files/ResultData/Workflow/TaskID/ |
示例：通过-i参数投递Copy-SAW-ST-V8流程，命令如下：
dcs task run -n Copy-SAW-ST-V8 -e C04138G3 -i ID=C04138G3 -i SN=C04138G3 -i Fastqs=[[\"/Files/CloudTestDataAll/DemoTestData/C04138G3/fastq/E250018257_L01_100_1.fq.gz\",\"/Files/CloudTestDataAll/DemoTestData/C04138G3/fastq/E250018257_L01_100_2.fq.gz\"]] -i ChipMask=/Files/CloudTestDataAll/DemoTestData/C04138G3/mask/C04138G3.barcodeToPos.h5 -i ImageTar=/Files/CloudTestDataAll/DemoTestData/C04138G3/image/C04138G3_SC_20241024_101338_4.0.0.tar.gz -i ReferenceIndex=[\"/Files/CloudTestDataAll/DemoTestData/SAW-v8/ref_result/mouse_1817819867701620738/mouse_bowtie2/Bowtie2/\",\"/Files/CloudTestDataAll/DemoTestData/SAW-v8/ref_result/mouse_kraken2_1817869844649914369/mouse_kraken2/Kraken2/\",\"/Files/CloudTestDataAll/DemoTestData/SAW-v8/ref_result/mouse_1817819034721234947/mouse/STAR/\"] -i "KitVersion=Stereo-seq N FFPE V1.0" -i Organism=mouse -i Tissue=brain -i UniquelyMappedOnly=false -i rRNARemove=false -i Mem=90
返回如下：
注意：当-i传入数组参数时，需要json转译方式填写，参考 i para=[["/Files/test1","/Files/test2"]]
通过-j传入参数 ，命令如下：
dcs task run -n [工作流名称] -j [json文件路径] [选项]
[工作流名称]：指定要运行的工作流名称
[json文件路径] ：指定投递任务时的json文件路径，json种需包含实体id、参数取值键值对，如
{
"entirtyId-1":{
"input_field1": "value1",
"input_field2": "value2"
},
"entityId-2":{
"input_field1": "value1",
"input_field2": "value2"
}
}
[选项]：指定工作流版本或者文件的输出路径
命令选项参数说明
| 短参数 | 长参数 | 参数格式 | 参数定义 | 示例 |
|---|---|---|---|---|
| -t | --type | 默认w（workflow）、s（shell） | 运行任务的脚本类型，type的值有w（workflow）、s（shell） | dcs task run -n Copy-SAW-ST-V8 -j /data/work/sdk_v8_test.json -o /Files/test/ |
| -v | --version | 流程版本 | 当运行任务脚本类型为workflow时，指定运行流程的版本，默认为最新版本 | |
| -o | --output | 数据管理路径，以'/Files/'路径开头 | 指定任务结果文件输出到数据管理的路径下，默认输出到/Files/ResultData/Workflow/TaskID/ |
示例：以json形式传入参数，运行名称为”Copy-SAW-ST-V8“,版本为”1.1.3“的流程，并输出到指定路径，命令如下
dcs task run -n Copy-SAW-ST-V8 -j /data/work/sdk_v8_test.json -o /Files/zhangsantest1/
json文件如下：
{
"C04138G3":
{
"ID": "C04138G3",
"SN": "C04138G3",
"Fastqs": [
[
"/Files/CloudTestDataAll/DemoTestData/C04138G3/fastq/E250018257_L01_100_1.fq.gz",
"/Files/CloudTestDataAll/DemoTestData/C04138G3/fastq/E250018257_L01_100_2.fq.gz"
]
],
"AdtFastqs": null,
"ChipMask": "/Files/CloudTestDataAll/DemoTestData/C04138G3/mask/C04138G3.barcodeToPos.h5",
"Image": null,
"ImageTar": "/Files/CloudTestDataAll/DemoTestData/C04138G3/image/C04138G3_SC_20241024_101338_4.0.0.tar.gz",
"ReferenceIndex": [
"/Files/CloudTestDataAll/DemoTestData/SAW-v8/ref_result/mouse_1817819867701620738/mouse_bowtie2/Bowtie2/",
"/Files/CloudTestDataAll/DemoTestData/SAW-v8/ref_result/mouse_kraken2_1817869844649914369/mouse_kraken2/Kraken2/",
"/Files/CloudTestDataAll/DemoTestData/SAW-v8/ref_result/mouse_1817819034721234947/mouse/STAR/"
],
"ProteinPanel": null,
"KitVersion": "Stereo-seq N FFPE V1.0",
"Organism": "mouse",
"Tissue": "brain",
"UniquelyMappedOnly": false,
"rRNARemove": false,
"Mem": 90
}
}
返回如下：
通过--table传入参数 ，命令如下：
dcs task run -n [工作流名称] --table [表格路径] [选项]
[工作流名称]：指定要运行的工作流名称
[表格路径] ：通过表格指定运行任务的输入参数，支持.csv .xlsx，表格表头需要与参数值对应，数组参数填写时需以json形式写，填写示例如下
| EntityID | ID | SN | Fastqs | ChipMask | Image | ImageTar | ReferenceIndex | KitVersion | Organism | Tissue | UniquelyMappedOnly | rRNARemove | Mem |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| C04138G3 | C04138G3 | C04138G3 | [["/Files/CloudTestDataAll/DemoTestData/C04138G3/fastq/E250018257_L01_100_1.fq.gz","/Files/CloudTestDataAll/DemoTestData/C04138G3/fastq/E250018257_L01_100_2.fq.gz"]] | /Files/CloudTestDataAll/DemoTestData/C04138G3/mask/C04138G3.barcodeToPos.h5 | /Files/CloudTestDataAll/DemoTestData/C04138G3/image/C04138G3_SC_20241024_101338_4.0.0.tar.gz | ["/Files/CloudTestDataAll/DemoTestData/SAW-v8/ref_result/mouse_1817819867701620738/mouse_bowtie2/Bowtie2/","/Files/CloudTestDataAll/DemoTestData/SAW-v8/ref_result/mouse_kraken2_1817869844649914369/mouse_kraken2/Kraken2/","/Files/CloudTestDataAll/DemoTestData/SAW-v8/ref_result/mouse_1817819034721234947/mouse/STAR/"] | Stereo-seq N FFPE V1.0 | mouse | brain | FALSE | FALSE | 90 | |
| A02677B5 | A02677B5 | A02677B5 | [["/Files/RawData/V350248064_L02_read_1.fq.gz","/Files/RawData/V350248064_L02_read_2.fq.gz"]] | /Files/RawData/A02677B5.barcodeToPos.h5 | /Files/RawData/A02677B5_SC_20241022_170055_4.0.0.tar.gz | ["/Files/CloudTestDataAll/DemoTestData/SAW-v8/ref_result/mouse_1817819034721234947/mouse/STAR/"] | Stereo-seq N FFPE V1.0 | mouse | brain | FALSE | FALSE | 90 | |
| Y00862D8 | Y00862D8 | Y00862D8 | [["/Files/RawData/V350099495_L04_read_1.fq.gz","/Files/RawData/V350099495_L04_read_2.fq.gz"]] | /Files/RawData/Y00862D8.barcodeToPos.h5 | /Files/Y00862D8_SC_20250117_142234_4.1.0-beta.25.tar.gz | ["/Files/CloudTestDataAll/DemoTestData/SAW-v8/ref_result/mouse_1817819034721234947/mouse/STAR/"] | Stereo-seq N FFPE V1.0 | mouse | brain | FALSE | FALSE | 90 |
表格填写注意事项
表格第一列必须为Entity ID
表格每一行划分为一条任务，若两行为两个相同的Entity ID 将会生成两条任务
每个单元格填写一个参数的取值，若参数需要传入（一维\二维）数组，填写时需要使用json方式填入，dc
表格表头需要与流程的参数相同用来匹配参数取值，例如参数名为“Fastqs”，系统会获取表头为“Fastqs”的单元格数据赋值给“Fastqs”参数
[选项]：指定工作流版本或者文件的输出路径
命令选项参数说明
| 短参数 | 长参数 | 参数格式 | 参数定义 | 示例 |
|---|---|---|---|---|
| -t | --type | 默认w（workflow）、s（shell） | 运行任务的脚本类型，type的值有w（workflow）、s（shell） | dcs task run -n Copy-SAW-ST-V8 -v 1.1.3--table /data/work/SAW-ST-V8_BGI.xlsx |
| -n | --name | 流程名称 | 当运行务脚本类型为workflow时，指定流程名称 | |
| -o | --output | 数据管理路径，以'/Files/'路径开头 | 指定任务结果文件输出到数据管理的路径下，默认输出到/Files/ResultData/Workflow/TaskID/ |
示例：以表格投递流程名称为”Copy-SAW-ST-V8“,版本为”1.1.3“的流程，命令如下
dcs task run -n Copy-SAW-ST-V8 --table /data/work/SAW-ST-V8_BGI.xlsx
返回如下
运行离线任务
通过命令投递的单个或批量离线任务，支持通过-i-p两种种形式投递
通过-i传入参数 ，命令如下：
dcs task run --type [脚本类型] -i [命令] -l [申请资源] --image [镜像url] [选项]
--type [脚本类型]：指定要运行的脚本类型，离线任务需传入"s"。
-i [命令]：指定需要执行的命令，执行文件里面写了解释器或者有可执行权限时传入方式为：-i /data/work/test.sh ，否则通过 -i "sh data/work test.sh"传入
-l [申请资源]：指定申请资源， vf=*g(指定内存),num_proc=*（指定核数）,gpu=L4/T4..（指定gpu类型）.
--image[镜像url]：指定镜像资源，需填写云平台镜像库中url路径
[选项]：可选填入，指定任务名称、挂载文件、结果文件输出路径
命令选项参数说明
| 短参数 | 长参数 | 参数格式 | 参数定义 | 示例 |
|---|---|---|---|---|
| -o | --output | 数据管理路径，以'/Files/'路径开头 | 指定任务结果文件输出到数据管理的路径下，默认输出到/Files/ResultData/Notebook/TaskID/ | dcs task run --type s -i /data/work/test.sh -l vf=32g,num_proc=8 --image 'stereonote/stereonote_conda_jupyterhub:latest' --output /Files/hxx0408 -m '/Files/gef/test3_NC.tissue16.gef,/Files/gef/test3_NC.tissue17.gef' |
| -m | --mount | 数据管理路径，以'/Files/'路径开头 | 当运行任务脚本类型为workflow时必填，指定运行流程的版本 | |
| -n | --name | 任务名称 | 指定分析任务时挂载的数据，使用数据管理的文件路径，多个文件按英文逗号分隔 |
示例：通过-i参数投递命令，命令如下：
dcs task run --type s -i /data/work/test.sh -l vf=32g,num_proc=8 --image 'stereonote/stereonote_conda_jupyterhub:latest' --output /Files/hxx0408 -m '/Files/gef/test3_NC.tissue16.gef,/Files/gef/test3_NC.tissue17.gef'
返回如下：
通过-p传入参数 ，命令如下：
dcs task run --type [脚本类型] -p [文件路径] -l [申请资源] --image [镜像url] [选项]
--type [脚本类型]：指定要运行的脚本类型，离线任务需传入"s"。
-p [命令]：work目录下的文件路径，运行指定路径下文件内容，文件中每行命令生成一条任务，适用于批量离线任务的投递
-l [申请资源]：指定申请资源， vf=*g(指定内存),num_proc=*（指定核数）,gpu=L4/T4..（指定gpu类型）.
--image[镜像url]：指定镜像资源，需填写云平台镜像库中url路径
[选项]：可选填入，指定任务名称、挂载文件、结果文件输出路径
命令选项参数说明
| 短参数 | 长参数 | 参数格式 | 参数定义 | 示例 |
|---|---|---|---|---|
| -o | --output | 数据管理路径，以'/Files/'路径开头 | 指定任务结果文件输出到数据管理的路径下，默认输出到/Files/ResultData/Notebook/TaskID/ | dcs task run -t s -p /data/work/test2.sh -l vf=32g,num_proc=8 --image 'stereonote/stereonote_conda_jupyterhub:latest' --output /Files/hxx0402-more -m '/Files/gef/test3_NC.tissue16.gef,/Files/gef/test3_NC.tissue17.gef' |
| -m | --mount | 数据管理路径，以'/Files/'路径开头 | 指定分析任务时挂载的数据，使用数据管理的文件路径，多个文件按英文逗号分隔，当前版本在代码中使用挂载路径时需要补全/data/input/ | |
| -n | --name | 任务名称 | 当运行任务脚本类型为workflow时必填，指定运行流程的版本 |
示例：通过-p参数投递命令，命令如下：
dcs task run -t s -p /data/work/test.sh -l vf=32g,num_proc=8 --image 'stereonote/stereonote_conda_jupyterhub:latest' --output /Files/hxx0402-more -m '/Files/gef/test3_NC.tissue16.gef,/Files/gef/test3_NC.tissue17.gef'
路径/data/work/test.sh下文件中每行命令为一条子任务
/data/work/test1.sh
/data/work/test2.sh
/data/work/test3.sh
/data/work/test4.sh
/data/work/test5.sh
/data/work/test6.sh
/data/work/test7.sh
/data/work/test8.sh
/data/work/test9.sh
/data/work/test10.sh
通过命令管理任务
通过命令管理管理流程分析以及离线任务
管理流程分析任务
查询任务列表，命令如下：
dcs task ls [选项]
[选项]：通过流程名称、创建人、tag查询任务，不接选项时，默认查询项目下的流程列表，默认返回10条
命令选项参数说明
| 短参数 | 长参数 | 参数格式 | 参数定义 | 示例 |
|---|---|---|---|---|
| -a | --all | - | 查询并返回所有任务列表 | dcs task ls -a |
| -o | --output | 本地work目录路径，/data/work/ | 输出文件路径，指定全路径如data/work/A.txt,则在work目录下生成名为A的文件，指定目录如data/work/，则在work目录下生成系统命名的文件。 | dcs task ls -o data/work/A.tx |
| -u | --user | 用户名 | 按创建人查询任务列表 | dcs task ls -u liuqing |
| -s | --status | 状态 | 按任务状态查询任务列表，状态分为：waiting、running、completed、warning、cancel、error | dcs task ls -s error |
| -n | --name | 本地/data/work路径 | 按流程名称查询任务列表 | dcs task ls -n SAW-ST-V8 |
| -i | --id | 云平台任务编号，多个以英文逗号分隔 | 按任务编号\批次号查询任务列表，多个任务编号用英文逗号分隔 | dcs task ls -i w0011,w00022 |
| -e | --entity | 云平台实体id，多个以英文逗号分隔 | 当运行任务脚本类型为workflow时,按任务实体ID查询任务列表，多个实体ID用英文逗号分隔 | dcs task ls -e C04138G3,C04138G3 |
| --time | --time YY/MM/DD~YY/MM/DD ~YY/MM/DD YY/MM/DD YY/MM/DD~ | 当任务类型为workflow时，按任务创建时间查询任务列表, --time 2025/01/01~2025/02/01 查截止 --time ~2025/02/01 查起始 --time 2025/02/01~ 精准查 --time 2025/01/01 | dcs task ls--time 2025/01/01~2025/02/01 |
示例：查询创建人为"xiaoyanqiu"，任务状态为“running”，实体id为"C04138G3"，创建时间为2025年4月15号的任务，命令如下
dcs task ls -u xiaoyanqiu -s running -e C04138G3 --time 2025/04/15
返回如下：
查询任务详情，命令如下
dcs task info [任务编号]
[任务编号]：云平台上流程分析的任务编号
示例：查看”W202504160002832“任务详情，命令如下
dcs task info W202504160002832
返回
启动任务，命令如下
dcs task start [任务编号] #云平台流程分析的任务编号，多个用英文逗号分隔
删除任务，命令如下
dcs task rm [任务编号] #云平台流程分析的任务编号，多个用英文逗号分隔
取消任务，命令如下
dcs task cancel [任务编号] #云平台流程分析的任务编号，多个用英文逗号分隔
查看任务日志，命令如下
dcs task log [任务编号] [选项]
[任务编号] ：云平台流程分析的任务编号
[选项]：通过指定步骤名称进一步查看任务步骤的标准输出
命令选项参数说明
| 短参数 | 长参数 | 参数定义 | 示例 |
|---|---|---|---|
| -n | --name | 查询指定步骤名称的输出日志，与--stdout/--stderr/--script一同使用，多线程时输入name-线程数 | - |
| --stdout | 查询指定步骤的stdout文件 | dcs task log WT202504150002891 -n count-1 --stdout | |
| --stderr | 查询指定步骤的stderr文件 | dcs task log WT202504150002891 -n count-1 --stderr | |
| --script | 查询指定步骤的scriptr文件，仅任务投递者本人可查看 | dcs task log WT202504150002891 -n count-1 --script |
示例：查询任务编号为”WT202504150002891“的日志信息，并查看标准输出，命令如下
dcs task log WT202504150002891
dcs task log WT202504150002891 -n count-1 --stdout
返回如下：
管理离线任务
查询离线父任务列表，命令如下：
dcs task ls -t a [选项]
[选项]：通过创建人、任务名称，任务编号查询列表，不接选项时，默认查询项目下的流程列表，默认返回10条
命令选项参数说明
| 短参数 | 长参数 | 参数格式 | 参数定义 | 示例 |
|---|---|---|---|---|
| -a | --all | - | 查询并返回所有任务列表 | dcs task ls -t a -a |
| -o | --output | 本地work目录路径，/data/work/ | 输出文件路径，指定全路径如data/work/A.txt,则在work目录下生成名为A的文件，指定目录如data/work/，则在work目录下生成系统命名的文件。 | dcs task ls -t a -o data/work/A.tx |
| -u | --user | 用户名 | 按创建人查询任务列表 | dcs task ls -t a -u liuqing |
| -n | --name | 云平台任务名称 | 按任务名称查询任务列表 | dcs task ls -t a -n SAW-ST-V8 |
| -i | --id | 云平台父任务编号，多个以英文逗号分隔 | 按任务编号\批次号查询任务列表，多个任务编号用英文逗号分隔 | dcs task ls -t a -i 1912091637272084481,1912054892207865858 |
示例：查询创建人为"hujiaming"的任务，查询符合条件的所有的任务列表，并保存在work目录下
dcs task ls -t a -u hujiaming -a -o /data/work/test0404.txt
返回如下：
进入/data/work/test0404.txt可产看任务列表
查询子父任务列表，命令如下：
dcs task info [父任务编号]
示例：查询父任务编号为”1912054939234402305“下的子任务列表
dcs task info 1912054939234402305
返回如下
查询子任务运行命令详情，命令如下
dcs task info [子任务编号]
示例：查看”1909494534729433090“任务详情，命令如下
dcs task info 1909494534729433090
返回示例如下
启动任务，命令如下
dcs task start [子任务编号] #云平台离线任务的子任务编号，多个用英文逗号分隔，
注意：只有失败的任务才可启动，且只有项目管理员、项目负责人及任务创建者可以操作
删除任务，命令如下
dcs task rm [子任务编号] #云平台离线任务的子任务编号，多个用英文逗号分隔
注意：可删除失败、完成任务，且只有项目管理员、项目负责人及任务创建者可以操作
查看子任务运行过程的资源消耗，命令如下
dcs task consume [子任务编号] #云平台离线任务的子任务编号
注意：只有项目管理员、项目负责人及任务创建者可以操作