Skip to main content

tw launch

Launch a pipeline

Run tw launch -h to view supported launch options.

tw launch [OPTIONS]

Options

OptionDescriptionRequiredDefault
--params-filePipeline parameters in JSON or YAML format. Provide the path to a file containing the content.
-c, --compute-envCompute environment identifier where the pipeline will run. Defaults to workspace primary compute environment if omitted. Provide the name or identifier.
-n, --nameCustom run name for the workflow execution.
--work-dirWork directory path where workflow intermediate files are stored. Defaults to compute environment work directory if omitted.
-p, --profileArray of Nextflow configuration profile names to apply.
-r, --revisionGit revision, branch, or tag to use.
--waitWait until workflow reaches specified status: SUBMITTED, RUNNING, SUCCEEDED, FAILED, CANCELLED
-l, --labelsLabels to assign to each pipeline run. Provide comma-separated label values (use key=value format for resource labels). Labels will be created if they don't exist
--launch-containerContainer image to use for the Nextflow launcher.
--configNextflow configuration as text (overrides config files). Provide the path to a file containing the content.
--pre-runAdd a script that executes in the nf-launch script prior to invoking Nextflow processes. See: https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts. Provide the path to a file containing the content.
--post-runAdd a script that executes after all Nextflow processes have completed. See: https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts. Provide the path to a file containing the content.
--pull-latestPull the latest version of the pipeline from the repository.
--stub-runExecute a stub run for testing (processes return dummy results).
--main-scriptAlternative main script filename. Default: main.nf.
--entry-nameWorkflow entry point name when using Nextflow DSL2.
--schema-nameName of the pipeline schema to use.
--user-secretsArray of user secrets to make available to the pipeline.
--workspace-secretsArray of workspace secrets to make available to the pipeline.
--disable-optimizationTurn off the optimization for the pipeline before launching.
--head-job-cpusNumber of CPUs allocated for the Nextflow head job.
--head-job-memoryMemory allocation for the Nextflow head job in megabytes.
-w, --workspaceWorkspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to TOWER_WORKSPACE_ID environment variable)TOWER_WORKSPACE_ID
tw launch -w 123456789012345 nf-hello-2026

Workflow 7q8r9s0t1u2v3 submitted at [my-organization-updated / my-workspace] workspace.

https://cloud.seqera.io/orgs/my-organization-updated/workspaces/my-workspace/watch/7q8r9s0t1u2v3