LogoLogo
  • Overview
  • publisher
    • Introduction
    • Getting Started
      • Logging in to Publisher
    • Data Sources
      • Connecting a Data Source
      • Managing a Data Source
      • Connectors
        • AWS S3 Permissions
        • Connecting to AWS S3 Storage
        • Google Cloud Storage (GCS) Permissions
        • Connecting to Google Cloud Storage
        • PostgreSQL Permissions
        • Connecting to PostgreSQL
        • PostgreSQL on Azure Permissions
        • Microsoft Azure Blob Storage Permissions
        • Connecting to Microsoft Azure Blob Storage
        • Connecting to HTTPS
        • Connecting to other sources via Trino
          • BigQuery
    • Collections
      • Creating a Collection
      • Sharing a Collection
      • Collection Filters
      • Editing Collection Metadata
      • Updating Collection Contents
    • Access Policies
      • Creating an Access Policy
      • Managing Access Policies
    • Questions
      • Adding Questions
      • Example Question
    • Settings
      • Viewing Current and Past Administrators
      • Adding an Administrator
      • Removing an Administrator
      • Setting Notification Preferences
  • Explorer
    • Introduction
    • Viewing a Collection
    • Browsing Collections
    • Asking Questions
    • Accessing a Private Collection
      • Requesting Access to a Private Collection
    • Filtering Data in Tables
      • Strings
      • Dates
      • Numbers
  • Workbench
    • Introduction
    • Getting Started
      • Logging into Workbench
      • Connecting an Engine
      • Finding or Importing a Workflow
      • Configuring Workflow Inputs
      • Running and Monitoring a Workflow
      • Locating Outputs
    • Engines
      • Adding and Updating an Engine
        • On AWS HealthOmics
        • On Microsoft Azure
        • On Google Cloud Platform
        • On Premises
      • Parameters
        • AWS HealthOmics
        • Google Cloud Platform
        • Microsoft Azure
        • On-Premises
        • Cromwell
        • Amazon Genomics CLI
    • Workflows
      • Finding Workflows
      • Adding a Workflow
      • Supported Languages
      • Repositories
        • Dockstore
    • Instruments
      • Getting Started with Instruments
      • Connecting a Storage Account
      • Using Sample Data in a Workflow
      • Running Workflows Using Samples
      • Family Based Analysis with Pedigree Information
      • Monitor the Workflow
      • CLI Reference
        • Instruments
        • Storage
        • Samples
        • OpenAPI Specification
    • Entities
    • Terminology
  • Passport
    • Introduction
    • Registering an Email Address for a Google Identity
  • Command Line Interface
    • Installation
    • Usage Examples
    • Working with JSON Data
    • Reference
      • workbench
        • runs submit
        • runs list
        • runs describe
        • runs cancel
        • runs delete
        • runs logs
        • runs tasks list
        • runs events list
        • engines list
        • engines describe
        • engines parameters list
        • engines parameters describe
        • engines health-checks list
        • workflows create
        • workflows list
        • workflows describe
        • workflows update
        • workflows delete
        • workflows versions create
        • workflows versions list
        • workflows versions describe
        • workflows versions files
        • workflows versions update
        • workflows versions delete
        • workflows versions defaults create
        • workflows versions defaults list
        • workflows versions defaults describe
        • workflows versions defaults update
        • workflows versions defaults delete
        • namespaces get-default
        • storage add
        • storage delete
        • storage describe
        • storage list
        • storage update
        • storage platforms add
        • storage platforms delete
        • storage platforms describe
        • storage platforms list
        • samples list
        • samples describe
        • samples files list
      • publisher
        • datasources list
  • Analysis
    • Python Library
    • Popular Environments
      • Cromwell
      • CWL Tool
      • Terra
      • Nextflow
      • DNAnexus
Powered by GitBook

© DNAstack. All rights reserved.

On this page
  • Synopsis
  • Description
  • Examples
  • Positional Arguments
  • WORKFLOW_FILE
  • Flags
  • --entrypoint=FILE
  • --workflow=WORKFLOW_ID
  • --name=TEXT
  • --description=FILE|TEXT

Was this helpful?

  1. Command Line Interface
  2. Reference
  3. workbench

workflows versions create

Create a version of a workflow in a namespace

Certainly, here's the updated documentation with the WORKFLOW_FILE marked as a required positional argument:

Synopsis

omics workbench workflows versions create --workflow=WORKFLOW_ID --name=TEXT
  [--description=FILE|TEXT]
  WORKFLOW_FILE...

Description

Create a new version within a specific workflow using the provided WORKFLOW_UUID and name. You can set the description and specify WDL files for the new version using the provided flags and the required positional argument.

Examples

Create a new version with the specified name for the given workflow:

omics workbench workflows versions create --workflow 123e4567-e89b-12d3-a456-426614174000 --name "New Version" main.wdl

Create a new version with a description provided in a Markdown file:

omics workbench workflows versions create --workflow 123e4567-e89b-12d3-a456-426614174000 --name "New Version" --description @new_version_description.md main.wdl

Positional Arguments

WORKFLOW_FILE

Required. A WDL or supporting text file that you would like to include as part of the new version. You can specify multiple files at once. The first WDL file specified will become the entry point of the new version.

The CLI transparently handles imports for you, inspecting each WDL and resolving/finding relative imports that are defined in the files. Because of this, it is typically sufficient to only specify the entry point of the new version, since all other files will be discoverable from that.

Flags

--entrypoint=FILE

A required flag to specify the entrypoint for the workflow. Needs to be a path of a file in a context of the workflow, e.g., main.wdl.

--workflow=WORKFLOW_ID

Required. Specify the UUID of the workflow in which you want to create a new version.

--name=TEXT

Required. Set the human-readable name for the new version. The version ID will be derived from the version name and must be unique within the specified workflow.

--description=FILE|TEXT

Provide or update the description of the new version. You can either provide the description directly as text or use a file containing the description in Markdown format.

Previousworkflows deleteNextworkflows versions list

Last updated 11 months ago

Was this helpful?