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
  • VERSION_ID
  • Flags
  • --workflow=WORKFLOW_ID
  • --path=PATH
  • --output=PATH
  • --zip

Was this helpful?

  1. Command Line Interface
  2. Reference
  3. workbench

workflows versions files

Prints or downloads workflow files

Synopsis

omics workbench workflows versions files --workflow=WORKFLOW_ID [VERSION_ID]
  [--path=PATH]
  [--output=PATH]
  [--zip]

Description

Retrieve files belonging to a workflow version using the provided WORKFLOW_ID and VERSION_ID parameters. Behaviour depends on the values set for the flags. See the examples below for more information.

Examples

Prints out the workflow's descriptor file to the screen:

omics workbench workflows versions files --workflow=12345678910 1.0.0

Prints the workflow file matching the given path to the screen. If the file is binary, the file contents will not be printed to the screen and a warning will be printed instead:

omics workbench workflows versions files --workflow=12345678910 1.0.0 \
  --path=my/path/file.wdl

Saves the content from the --path file as a file in the location specified by --output:

omics workbench workflows versions files --workflow=12345678910 1.0.0 \
  --path=my/path/file.wdl
  --output=output/new_file.txt

Saves all the workflow's files in the same hierarchy in the location specified by --output. Note: --output must end with a folder in order to store all the workflow's files:

omics workbench workflows versions files --workflow=12345678910 1.0.0 \
  --output=output/folder

Downloads the file specified by --path as a zip file in the location specified by --output:

omics workbench workflows versions files --workflow=12345678910 1.0.0 \
  --path=my/path/file.wdl
  --output=output/new_file.zip
  --zip

Downloads the file specified by --path as a zip file named 12345678910-1.0.0-files.zip ({workflow_name}-{workflow_version}-files.zip) in the folder location specified by --output:

omics workbench workflows versions files --workflow=12345678910 1.0.0 \
  --path=my/path/file.wdl
  --output=output/folder
  --zip

Downloads the file specified by --path as a zip file named 12345678910-1.0.0-files.zip in the current working directory:

omics workbench workflows versions files --workflow=12345678910 1.0.0 \
  --path=my/path/file.wdl
  --zip

Downloads all files in the workflow in the zip file location specified by --output:

omics workbench workflows versions files --workflow=12345678910 1.0.0 \
  --output=output/all_files.zip
  --zip

Downloads all files in the workflow as a zip file named 12345678910-1.0.0-files.zipin the folder location specified by --output:

omics workbench workflows versions files --workflow=12345678910 1.0.0 \
  --output=output/all_files
  --zip

Downloads all files in the workflow as a zip file named 12345678910-1.0.0-files.zip in the current working directory:

omics workbench workflows versions files --workflow=12345678910 1.0.0 \
  --zip

Positional Arguments

VERSION_ID

Required. Specify a version identifier (VERSION_ID) to retrieve the files corresponding to the workflow's specific version.

Flags

--workflow=WORKFLOW_ID

Required. Specify the UUID of the workflow for which you want to describe versions.

--path=PATH

The path for the specific file in the workflow that is to be printed to the screen or downloaded.

--output=PATH

The location where a workflow file or files will be downloaded. Note: if --path is not specified (i.e. you are downloading multiple files) then --output must end with a folder and not an existing file name.

--zip

If specified, the file(s) will be downloaded as into a zip file. Note: if --output is not specified or does not end with a zip file, then it will create a zip file with the naming convention {workflow_name}-{workflow_version}-files.zip.

Previousworkflows versions describeNextworkflows versions update

Last updated 1 year ago

Was this helpful?