Index of dx commands

This page contains the help messages for each of the commands under dx, grouped by their primary category.

Get started

`dx`

usage: dx [-h] [--version] command ...

DNAnexus Command-Line Client, API v1.0.0, client v0.401.0

dx is a command-line client for interacting with the DNAnexus platform.  You
can log in, navigate, upload, organize and share your data, launch analyses,
and more.  For a quick tour of what the tool can do, see

  https://documentation.dnanexus.com/getting-started/tutorials/cli-quickstart#quickstart-for-cli

For a breakdown of dx commands by category, run "dx help".

dx exits with exit code 3 if invalid input is provided or an invalid operation
is requested, and exit code 1 if an internal error is encountered.  The latter
usually indicate bugs in dx; please report them at

  https://github.com/dnanexus/dx-toolkit/issues

options:
  -h, --help  show this help message and exit
  --env-help  Display help message for overriding environment
              variables
  --version   show program's version number and exit

`help`

usage: dx help [-h] [command_or_category] [subcommand]

Displays the help message for the given command (and subcommand if given), or
displays the list of all commands in the given category.

CATEGORIES

  all		All commands
  session	Manage your login session
  fs		Navigate and organize your projects and files
  data		View, download, and upload data
  metadata	View and modify metadata for projects, data, and executions
  workflow	View and modify workflows
  exec		Manage and run apps, applets, and workflows
  org		Administer and operate on orgs
  other		Miscellaneous advanced utilities

EXAMPLE

  To find all commands related to running and monitoring a job and then display
  the help message for the command "run", run

  $ dx help exec
    <list of all execution-related dx commands>
  $ dx help run
    <help message for dx run>

positional arguments:
  command_or_category  Display the help message for the given command, or the
                       list of all available commands for the given category
  subcommand           Display the help message for the given subcommand of
                       the command

options:
  -h, --help           show this help message and exit

Override environment variables

usage: dx command ... [--apiserver-host APISERVER_HOST]
                      [--apiserver-port APISERVER_PORT]
                      [--apiserver-protocol APISERVER_PROTOCOL]
                      [--project-context-id PROJECT_CONTEXT_ID]
                      [--workspace-id WORKSPACE_ID]
                      [--security-context SECURITY_CONTEXT]
                      [--auth-token AUTH_TOKEN]

options:
  --apiserver-host APISERVER_HOST
                        API server host
  --apiserver-port APISERVER_PORT
                        API server port
  --apiserver-protocol APISERVER_PROTOCOL
                        API server protocol (http or https)
  --project-context-id PROJECT_CONTEXT_ID
                        Default project or project context ID
  --workspace-id WORKSPACE_ID
                        Workspace ID (for jobs only)
  --security-context SECURITY_CONTEXT
                        JSON string of security context
  --auth-token AUTH_TOKEN
                        Authentication token

Category: session in dx help

`logout`

`exit`

usage: dx exit [-h]

Exit out of the interactive shell

options:
  -h, --help  show this help message and exit

`whoami`

`env`

`clearenv`

`setenv`

Navigate and organize files

Category: fs in dx help

`ls`

`tree`

`pwd`

`select`

`cd`

`cp`

`mv`

`mkdir`

`rmdir`

`rm`

`rmproject`

`archive`

`unarchive`

`list database files`

usage: dx list database files [-h] [--env-help] [--folder FOLDER] [--recurse]
                              [--csv] [--timeout TIMEOUT]
                              database

List files associated with a specific database

positional arguments:
  database           Data object ID or path of the database.

options:
  -h, --help         show this help message and exit
  --env-help         Display help message for overriding environment variables
  --folder FOLDER    Name of folder (directory) in which to start searching
                     for database files. This will typically match the name of
                     the table whose files are of interest. The default value
                     is "/" which will start the search at the root folder of
                     the database.
  --recurse          Look for files recursively down the directory structure.
                     Otherwise, by default, only look on one level.
  --csv              Write output as comma delimited fields, suitable as CSV
                     format.
  --timeout TIMEOUT  Number of seconds to wait before aborting the request. If
                     omitted, default timeout is 120 seconds.

View, download, and upload data

Category: data in dx help

File transfer

`upload`

`download`

`make_download_url`

View data

`describe`

See also: get_details, ls, find data

usage: dx describe [-h] [--json] [--color {off,on,auto}]
                   [--delimiter [DELIMITER]] [--env-help] [--details]
                   [--verbose] [--name] [--multi] [--try T]
                   path

Describe a DNAnexus entity.  Use this command to describe data objects by name
or ID, jobs, apps, users, organizations, etc.  If using the "--json" flag, it
will thrown an error if more than one match is found (but if you would like a
JSON array of the describe hashes of all matches, then provide the "--multi"
flag).  Otherwise, it will always display all results it finds.

NOTES:

- The project found in the path is used as a HINT when you are using an object
ID; you may still get a result if you have access to a copy of the object in
some other project, but if it exists in the specified project, its description
will be returned.

- When describing apps or applets, options marked as advanced inputs will be
hidden unless --verbose is provided

positional arguments:
  path                  Object ID or path to an object (possibly in another
                        project) to describe.

options:
  -h, --help            show this help message and exit
  --json                Display return value in JSON
  --color {off,on,auto}
                        Set when color is used (color=auto is used when stdout
                        is a TTY)
  --delimiter, --delim [DELIMITER]
                        Always use exactly one of DELIMITER to separate fields
                        to be printed; if no delimiter is provided with this
                        flag, TAB will be used
  --env-help            Display help message for overriding environment
                        variables
  --details             Include details of data objects
  --verbose             Include additional metadata
  --name                Only print the matching names, one per line
  --multi               If the flag --json is also provided, then returns a
                        JSON array of describe hashes of all matching results
  --try T               When describing a job that was restarted, describe job
                        try T. T=0 refers to the first try. Default is the
                        last job try.

`cat`

`head`

Create data objects

`new`

usage: dx new [-h] class ...

Use this command with one of the available subcommands (classes) to create a
new project or data object from scratch. Not all data types are supported. See
'dx upload' for files and 'dx build' for applets.

positional arguments:
  class
    user      Create a new user account
    org       Create new non-billable org
    project   Create a new project
    record    Create a new record
    workflow  Create a new workflow

options:
  -h, --help  show this help message and exit

`new project`

See also: new, rmproject, find projects

usage: dx new project [-h] [--brief | --verbose] [--env-help]
                      [--region REGION] [-s] [--bill-to BILL_TO] [--phi]
                      [--database-ui-view-only]
                      [--database-results-restricted DATABASE_RESULTS_RESTRICTED]
                      [--monthly-compute-limit MONTHLY_COMPUTE_LIMIT]
                      [--monthly-egress-bytes-limit MONTHLY_EGRESS_BYTES_LIMIT]
                      [--monthly-storage-limit MONTHLY_STORAGE_LIMIT]
                      [--default-symlink DEFAULT_SYMLINK] [--drive DRIVE]
                      [name]

Create a new project

positional arguments:
  name                  Name of the new project

options:
  -h, --help            show this help message and exit
  --brief               Display a brief version of the return value; for most
                        commands, prints a DNAnexus ID per line
  --verbose             If available, displays extra verbose output
  --env-help            Display help message for overriding environment
                        variables
  --region REGION       Region affinity of the new project
  -s, --select          Select the new project as current after creating
  --bill-to BILL_TO     ID of the user or org to which the project will be
                        billed. The default value is the billTo of the
                        requesting user.
  --phi                 Add PHI protection to project
  --database-ui-view-only
                        Viewers on the project cannot access database data
                        directly
  --database-results-restricted DATABASE_RESULTS_RESTRICTED
                        Viewers on the project can access only more than
                        specified size of visual data from databases
  --monthly-compute-limit MONTHLY_COMPUTE_LIMIT
                        Monthly project spending limit for compute
  --monthly-egress-bytes-limit MONTHLY_EGRESS_BYTES_LIMIT
                        Monthly project spending limit for egress (in Bytes)
  --monthly-storage-limit MONTHLY_STORAGE_LIMIT
                        Monthly project spending limit for storage
  --default-symlink DEFAULT_SYMLINK
                        Default symlink for external storage account
  --drive DRIVE         Drive for external storage account

`new record`

`new workflow`

usage: dx new workflow [-h] [--visibility {hidden,visible}]
                       [--property KEY=VALUE] [--type TYPE] [--tag TAG]
                       [--details DETAILS] [-p] [--brief | --verbose]
                       [--env-help] [--title TITLE] [--summary SUMMARY]
                       [--description DESCRIPTION]
                       [--output-folder OUTPUT_FOLDER] [--init INIT]
                       [path]

Create a new workflow

positional arguments:
  path                  DNAnexus path for the new data object (default uses
                        current project and folder if not provided)

options:
  -h, --help            show this help message and exit
  --brief               Display a brief version of the return value; for most
                        commands, prints a DNAnexus ID per line
  --verbose             If available, displays extra verbose output
  --env-help            Display help message for overriding environment
                        variables
  --title TITLE         Workflow title
  --summary SUMMARY     Workflow summary
  --description DESCRIPTION
                        Workflow description
  --output-folder OUTPUT_FOLDER
                        Default output folder for the workflow
  --init INIT           Path to workflow or an analysis ID from which to
                        initialize all metadata

metadata arguments:
  --visibility {hidden,visible}
                        Whether the object is hidden or not
  --property KEY=VALUE  Key-value pair to add as a property; repeat as
                        necessary,
                         e.g. "--property key1=val1 --property key2=val2"
  --type TYPE           Type of the data object; repeat as necessary,
                         e.g. "--type type1 --type type2"
  --tag TAG             Tag of the data object; repeat as necessary,
                         e.g. "--tag tag1 --tag tag2"
  --details DETAILS     JSON to store as details
  -p, --parents         Create any parent folders necessary

Data object operations

`close`

`wait`

`get`

Searching

`find data`

See also: find projects, ls, describe

usage: dx find data [-h] [--brief | --verbose] [--json]
                    [--color {off,on,auto}] [--delimiter [DELIMITER]]
                    [--env-help] [--property KEY[=VALUE]] [--tag TAG]
                    [--class {record,file,applet,workflow,database}]
                    [--state {open,closing,closed,any}]
                    [--visibility {hidden,visible,either}] [--name NAME]
                    [--name-mode {glob,exact,regexp}] [--type TYPE]
                    [--link LINK] [--all-projects] [--path PROJECT:FOLDER]
                    [--norecurse] [--created-after CREATED_AFTER]
                    [--created-before CREATED_BEFORE] [--mod-after MOD_AFTER]
                    [--mod-before MOD_BEFORE] [--region REGION]

Finds data objects subject to the given search parameters. By default,
restricts the search to the current project if set. To search over all
projects (excluding public projects), use --all-projects (overrides --path and
--norecurse).

options:
  -h, --help            show this help message and exit
  --brief               Display a brief version of the return value; for most
                        commands, prints a DNAnexus ID per line
  --verbose             If available, displays extra verbose output
  --json                Display return value in JSON
  --color {off,on,auto}
                        Set when color is used (color=auto is used when stdout
                        is a TTY)
  --delimiter, --delim [DELIMITER]
                        Always use exactly one of DELIMITER to separate fields
                        to be printed; if no delimiter is provided with this
                        flag, TAB will be used
  --env-help            Display help message for overriding environment
                        variables
  --property KEY[=VALUE]
                        Key-value pair of a property or simply a property key;
                        if only a key is provided, matches a result that has
                        the key with any value; repeat as necessary, e.g. "--
                        property key1=val1 --property key2"
  --tag TAG             Tag to match; repeat as necessary, e.g. "--tag tag1
                        --tag tag2" will require both tags
  --class {record,file,applet,workflow,database}
                        Data object class
  --state {open,closing,closed,any}
                        State of the object
  --visibility {hidden,visible,either}
                        Whether the object is hidden or not
  --name NAME           Search criteria for the object name, interpreted
                        according to the --name-mode
  --name-mode {glob,exact,regexp}
                        Name mode to use for searching
  --type TYPE           Type of the data object
  --link LINK           Object ID that the data object links to
  --all-projects, --allprojects
                        Extend search to all projects (excluding public
                        projects)
  --path PROJECT:FOLDER
                        Project and/or folder in which to restrict the results
  --norecurse           Do not recurse into subfolders
  --created-after CREATED_AFTER
                        Date (e.g. --created-after="2021-12-01" or --created-
                        after="2021-12-01 19:01:33") or integer Unix epoch
                        timestamp in milliseconds (e.g. --created-
                        after=1642196636000) after which the object was
                        created. You can also specify negative numbers to
                        indicate a time period in the past suffixed by s, m,
                        h, d, w, M or y to indicate seconds, minutes, hours,
                        days, weeks, months or years (e.g. --created-after=-2d
                        for objects created in the last 2 days).
  --created-before CREATED_BEFORE
                        Date (e.g. --created-before="2021-12-01" or --created-
                        before="2021-12-01 19:01:33") or integer Unix epoch
                        timestamp in milliseconds (e.g. --created-
                        before=1642196636000) before which the object was
                        created. You can also specify negative numbers to
                        indicate a time period in the past suffixed by s, m,
                        h, d, w, M or y to indicate seconds, minutes, hours,
                        days, weeks, months or years (e.g. --created-
                        before=-2d for objects created earlier than 2 days
                        ago)
  --mod-after MOD_AFTER
                        Date (e.g. --mod-after="2021-12-01" or --mod-
                        after="2021-12-01 19:01:33") or integer Unix epoch
                        timestamp in milliseconds (e.g. --mod-
                        after=1642196636000) after which the object was
                        modified. You can also specify negative numbers to
                        indicate a time period in the past suffixed by s, m,
                        h, d, w, M or y to indicate seconds, minutes, hours,
                        days, weeks, months or years (e.g. --mod-after=-2d for
                        objects modified in the last 2 days)
  --mod-before MOD_BEFORE
                        Date (e.g. --mod-before="2021-12-01" or --mod-
                        before="2021-12-01 19:01:33") or integer Unix epoch
                        timestamp in milliseconds (e.g. --mod-
                        before=1642196636000) before which the object was
                        modified. You can also specify negative numbers to
                        indicate a time period in the past suffixed by s, m,
                        h, d, w, M or y to indicate seconds, minutes, hours,
                        days, weeks, months or years (e.g. --mod-before=-2d
                        for objects modified earlier than 2 days ago)
  --region REGION       Restrict the search to the provided region

`find projects`

usage: dx find projects [-h] [--brief | --verbose] [--json]
                        [--delimiter [DELIMITER]] [--env-help]
                        [--property KEY[=VALUE]] [--tag TAG]
                        [--phi {true,false}] [--name NAME]
                        [--level {VIEW,UPLOAD,CONTRIBUTE,ADMINISTER}]
                        [--public] [--created-after CREATED_AFTER]
                        [--created-before CREATED_BEFORE] [--region REGION]
                        [--external-upload-restricted {true,false}]

Finds projects subject to the given search parameters. Use the --public flag
to list all public projects.

options:
  -h, --help            show this help message and exit
  --brief               Display a brief version of the return value; for most
                        commands, prints a DNAnexus ID per line
  --verbose             If available, displays extra verbose output
  --json                Display return value in JSON
  --delimiter, --delim [DELIMITER]
                        Always use exactly one of DELIMITER to separate fields
                        to be printed; if no delimiter is provided with this
                        flag, TAB will be used
  --env-help            Display help message for overriding environment
                        variables
  --property KEY[=VALUE]
                        Key-value pair of a property or simply a property key;
                        if only a key is provided, matches a result that has
                        the key with any value; repeat as necessary, e.g. "--
                        property key1=val1 --property key2"
  --tag TAG             Tag to match; repeat as necessary, e.g. "--tag tag1
                        --tag tag2" will require both tags
  --phi {true,false}    If set to true, only projects that contain PHI data
                        will be retrieved. If set to false, only projects that
                        do not contain PHI data will be retrieved.
  --name NAME           Name of the project
  --level {VIEW,UPLOAD,CONTRIBUTE,ADMINISTER}
                        Minimum level of permissions expected
  --public              Include ONLY public projects (will automatically set
                        --level to VIEW)
  --created-after CREATED_AFTER
                        Date (e.g. --created-after="2021-12-01" or --created-
                        after="2021-12-01 19:01:33") or integer Unix epoch
                        timestamp in milliseconds (e.g. --created-
                        after=1642196636000) after which the project was
                        created. You can also specify negative numbers to
                        indicate a time period in the past suffixed by s, m,
                        h, d, w, M or y to indicate seconds, minutes, hours,
                        days, weeks, months or years (e.g. --created-after=-2d
                        for projects created in the last 2 days).
  --created-before CREATED_BEFORE
                        Date (e.g. --created-before="2021-12-01" or --created-
                        before="2021-12-01 19:01:33") or integer Unix epoch
                        timestamp in milliseconds (e.g. --created-
                        before=1642196636000) before which the project was
                        created. You can also specify negative numbers to
                        indicate a time period in the past suffixed by s, m,
                        h, d, w, M or y to indicate seconds, minutes, hours,
                        days, weeks, months or years (e.g. --created-
                        before=-2d for projects created earlier than 2 days
                        ago)
  --region REGION       Restrict the search to the provided region
  --external-upload-restricted {true,false}
                        If set to true, only externalUploadRestricted projects
                        will be retrieved. If set to false, only projects that
                        are not externalUploadRestricted will be retrieved.

Project management

`update project`

usage: dx update project [-h] [--brief | --verbose] [--env-help] [--name NAME]
                         [--summary SUMMARY] [--description DESCRIPTION]
                         [--protected {true,false}]
                         [--restricted {true,false}]
                         [--download-restricted {true,false}]
                         [--containsPHI {true}]
                         [--external-upload-restricted {true,false}]
                         [--database-ui-view-only {true,false}]
                         [--bill-to BILL_TO]
                         [--https-app-isolated-browsing {true,false}]
                         [--https-app-isolated-browsing-options HTTPS_APP_ISOLATED_BROWSING_OPTIONS]
                         [--allowed-executables ALLOWED_EXECUTABLES [ALLOWED_EXECUTABLES ...] |
                         --unset-allowed-executables]
                         [--database-results-restricted DATABASE_RESULTS_RESTRICTED |
                         --unset-database-results-restricted]
                         project_id

positional arguments:
  project_id            Project ID or project name

options:
  -h, --help            show this help message and exit
  --brief               Display a brief version of the return value; for most
                        commands, prints a DNAnexus ID per line
  --verbose             If available, displays extra verbose output
  --env-help            Display help message for overriding environment
                        variables
  --name NAME           New project name
  --summary SUMMARY     Project summary
  --description DESCRIPTION
                        Project description
  --protected {true,false}
                        Whether the project should be PROTECTED
  --restricted {true,false}
                        Whether the project should be RESTRICTED
  --download-restricted {true,false}
                        Whether the project should be DOWNLOAD RESTRICTED
  --containsPHI {true}  Flag to tell if project contains PHI
  --external-upload-restricted {true,false}
                        Whether uploads of file and table data to the project
                        should be restricted
  --database-ui-view-only {true,false}
                        Whether the viewers on the project can access the
                        database data directly
  --bill-to BILL_TO     Update the user or org ID of the billing account
  --https-app-isolated-browsing {true,false}
                        Whether all https access to jobs in this project
                        should be wrapped in Isolated Browsing. If true,
                        httpsApp-enabled executables must have
                        httpsApp.shared_access set to 'NONE' to run in this
                        project.
  --https-app-isolated-browsing-options HTTPS_APP_ISOLATED_BROWSING_OPTIONS
                        A JSON string with options for Isolated Browsing. See
                        https://documentation.dnanexus.com/developer/api/data-
                        containers/projects#api-method-project-xxxx-update for
                        a list of supported keys.
  --allowed-executables ALLOWED_EXECUTABLES [ALLOWED_EXECUTABLES ...]
                        Executable ID(s) this project is allowed to run. This
                        operation overrides any existing list of executables.
  --unset-allowed-executables
                        Removes any restriction to run executables as set by
                        --allowed-executables
  --database-results-restricted DATABASE_RESULTS_RESTRICTED
                        Viewers on the project can access only more than
                        specified size of visual data from databases
  --unset-database-results-restricted
                        Removes any restriction to return data from databases
                        as set by --database-results-restricted

Datasets and cohorts

`create_cohort`

usage: dx create_cohort [--brief | --verbose] --from FROM
                        (--cohort-ids COHORT_IDS |
                        --cohort-ids-file COHORT_IDS_FILE) [-h]
                        [PATH]

Generates a new Cohort object on the platform from an existing Dataset or
Cohort object and using list of IDs.

positional arguments:
  PATH                  DNAnexus path for the new data object. If not
                        provided, default behavior uses current project and
                        folder, and will name the object identical to the
                        assigned record-id.

options:
  --brief               Display a brief version of the return value; for most
                        commands, prints a DNAnexus ID per line
  --verbose             If available, displays extra verbose output
  --from FROM           v3.0 Dataset or Cohort object ID, project-id:record-
                        id, where ":record-id" indicates the record-id in
                        current selected project, or name
  --cohort-ids COHORT_IDS
                        A set of IDs used to subset the Dataset or Cohort
                        object as a comma-separated string. IDs must match
                        identically in the supplied Dataset. If a Cohort is
                        supplied instead of a Dataset, the intersection of
                        supplied and existing cohort IDs will be used to
                        create the new cohort.
  --cohort-ids-file COHORT_IDS_FILE
                        A set of IDs used to subset the Dataset or Cohort
                        object in a file with one ID per line and no header.
                        IDs must match identically in the supplied Dataset. If
                        a Cohort is supplied instead of a Dataset, the
                        intersection of supplied and existing cohort IDs will
                        be used to create the new cohort.
  -h, --help            Return the docstring and exit

`extract_dataset`

usage: dx extract_dataset [-h] [-ddd] [--fields FIELDS]
                          [--fields-file FIELDS_FILE] [--sql]
                          [--delim [DELIM]] [-o OUTPUT] [--list-fields]
                          [--list-entities] [--entities ENTITIES]
                          path

Retrieves the data or generates SQL to retrieve the data from a dataset or
cohort for a set of entity.fields. Additionally, the dataset's dictionary can
be extracted independently or in conjunction with data. Provides listing
options for entities and fields.

positional arguments:
  path                  v3.0 Dataset or Cohort object ID (project-id:record-id
                        where "record-id" indicates the record ID in the
                        currently selected project) or name

options:
  -h, --help            show this help message and exit
  -ddd, --dump-dataset-dictionary
                        If provided, the three dictionary files,
                        <record_name>.data_dictionary.csv,
                        <record_name>.entity_dictionary.csv, and
                        <record_name>.codings.csv will be generated. Files
                        will be comma delimited and written to the local
                        working directory, unless otherwise specified using
                        --delimiter and --output arguments. If stdout is
                        specified with the output argument, the data
                        dictionary, entity dictionary, and coding are output
                        in succession, without separators. If any of the three
                        dictionary files does not contain data (i.e. the
                        dictionary is empty), then that particular file will
                        not be created (or be output if the output is stdout).
  --fields FIELDS       A comma-separated string where each value is the
                        phenotypic entity name and field name, separated by a
                        dot. For example: "<entity_name>.<field_name>,<entity_
                        name>.<field_name>". Internal spaces are permitted. If
                        multiple entities are provided, field values will be
                        automatically inner joined. If only the --fields
                        argument is provided, data will be retrieved and
                        returned. If both --fields and --sql arguments are
                        provided, a SQL statement to retrieve the specified
                        field data will be automatically generated and
                        returned. Alternatively, use --fields-file option when
                        the number of fields to be retrieved is large.
  --fields-file FIELDS_FILE
                        A file with no header and one entry per line where
                        every entry is the phenotypic entity name and field
                        name, separated by a dot. For example:
                        <entity_name>.<field_name>. If multiple entities are
                        provided, field values will be automatically inner
                        joined. If only the --fields-file argument is
                        provided, data will be retrieved and returned. If both
                        --fields-file and --sql arguments are provided, a SQL
                        statement to retrieve the specified field data will be
                        automatically generated and returned. May not be used
                        in conjunction with the argument --fields.
  --sql                 If provided, a SQL statement (string) will be returned
                        to query the set of entity.fields, instead of
                        returning stored values from the set of entity.fields
  --delim, --delimiter [DELIM]
                        Always use exactly one of DELIMITER to separate fields
                        to be printed; if no delimiter is provided with this
                        flag, COMMA will be used
  -o, --output OUTPUT   Local filename or directory to be used ("-" indicates
                        stdout output). If not supplied, output will create a
                        file with a default name in the current folder
  --list-fields         List the names and titles of all fields available in
                        the dataset specified. When not specified together
                        with "–-entities", it will return all the fields from
                        the main entity. Output will be a two column table,
                        field names and field titles, separated by a tab,
                        where field names will be of the format, "<entity
                        name>.<field name>" and field titles will be of the
                        format, "<field title>".
  --list-entities       List the names and titles of all the entities
                        available in the dataset specified. Output will be a
                        two column table, entity names and entity titles,
                        separated by a tab.
  --entities ENTITIES   Similar output to "--list-fields", however using "--
                        entities" will allow for specific entities to be
                        specified. When multiple entities are specified, use
                        comma as the delimiter. For example: "--list-fields
                        --entities entityA,entityB,entityC"

`extract_assay expression`

usage: dx extract_assay expression [-h] [--list-assays]
                                   [--retrieve-expression]
                                   [--additional-fields-help]
                                   [--assay-name ASSAY_NAME]
                                   [--filter-json FILTER_JSON]
                                   [--filter-json-file FILTER_JSON_FILE]
                                   [--json-help] [--sql]
                                   [--additional-fields ADDITIONAL_FIELDS [ADDITIONAL_FIELDS ...]]
                                   [--expression-matrix] [--delim DELIM]
                                   [--output OUTPUT]
                                   [path]

Retrieve the selected data or generate SQL to retrieve the data from a
molecular expression assay in a dataset or cohort based on provided rules.

positional arguments:
  path                  v3.0 Dataset or Cohort object ID, project-id:record-
                        id, where ":record-id" indicates the record-id in
                        current selected project, or name

options:
  -h, --help            show this help message and exit
  --list-assays         List molecular expression assays available for query
                        in the specified Dataset or Cohort object
  --retrieve-expression
                        A flag to support, specifying criteria of molecular
                        expression to retrieve. Retrieves rows from the
                        expression table, optionally extended with sample and
                        annotation information where the extension is inline
                        without affecting row count. By default returns the
                        following set of fields; "sample_id", "feature_id",
                        and "value". Additional fields may be returned using "
                        --additional-fields". May be used with either "--
                        filter-json" or "--filter-json-file". Specify "--json-
                        help" following this option to get detailed
                        information on the json format and filters. When
                        filtering, one, and only one of "location",
                        "annotation.feature_id", or "annotation.feature_name"
                        may be supplied. If a Cohort object is supplied,
                        returned samples will be initially filtered to match
                        the cohort-defined set of samples, and any additional
                        filters will only further refine the cohort-defined
                        set. If no filter is provided, a SQL query returning
                        all data will be generated. In this case, the --sql
                        parameter must be used.
  --additional-fields-help
                        List all fields available for output.
  --assay-name ASSAY_NAME
                        Specify a specific molecular expression assay to
                        query. If the argument is not specified, the default
                        assay used is the first assay listed when using the
                        argument, "--list-assays"
  --filter-json, -j FILTER_JSON
                        The full input JSON object as a string and
                        corresponding to "--retrieve-expression". Must be used
                        with "--retrieve-expression" flag. Either "--filter-
                        json" or "--filter-json-file" may be supplied, not
                        both. If no filter is provided, a SQL query returning
                        all data will be generated. In this case, the --sql
                        parameter must be used.
  --filter-json-file, -f FILTER_JSON_FILE
                        The full input JSON object as a file and corresponding
                        to "--retrieve-expression". Must be used with "--
                        retrieve-expression" flag. Either "--filter-json" or "
                        --filter-json-file" may be supplied, not both. If no
                        filter is provided, a SQL query returning all data
                        will be generated. In this case, the --sql parameter
                        must be used.
  --json-help           When set, return a json template of "--retrieve-
                        expression" and a list of filters with definitions.
  --sql                 If the flag is provided, a SQL statement (as a string)
                        will be returned for the user to further query the
                        specified data, instead of returning actual data
                        values. If used without a json filter, returns all
                        data. Use of "--sql" is not supported when also using
                        the flag, --expression-matrix/-em
  --additional-fields ADDITIONAL_FIELDS [ADDITIONAL_FIELDS ...]
                        A set of fields to return, in addition to the default
                        set; "sample_id", "feature_id", and "value". Fields
                        must be represented as field names and supplied as a
                        single string, where each field name is separated by a
                        single comma. For example, fieldA,fieldB,fieldC. Use "
                        --additional-fields-help" to get the full list of
                        output fields available.
  --expression-matrix, -em
                        If the flag is provided with "--retrieve-expression",
                        the returned data will be a matrix of sample IDs
                        (rows) by feature IDs (columns), where each cell is
                        the respective pairwise value. The flag is not
                        compatible with "--additional-fields". Additionally,
                        the flag is not compatible with an "expression"
                        filter. If the underlying expression value is missing,
                        the value will be empty in returned data. Use of
                        --expression-matrix/-em is not supported when also
                        using the flag, "--sql".
  --delim, --delimiter DELIM
                        Always use exactly one of DELIMITER to separate fields
                        to be printed; if no delimiter is provided with this
                        flag, COMMA will be used. If a file is specified and
                        no --delim argument is passed or is COMMA, the file
                        suffix will be ".csv". If a file is specified and the
                        --delim argument is TAB, the file suffix will be
                        ".tsv". Otherwise, if a file is specified and "--
                        delim" is neither COMMA or TAB file suffix will be
                        ".txt".
  --output, -o OUTPUT   A local filename to be used, where "-" indicates
                        printing to STDOUT. If -o/--output is not supplied,
                        default behavior is to create a file with a
                        constructed name in the current folder.

`extract_assay germline`

usage: dx extract_assay germline [-h] [--assay-name ASSAY_NAME]
                                 (--list-assays |
                                 --retrieve-allele [RETRIEVE_ALLELE] |
                                 --retrieve-annotation [RETRIEVE_ANNOTATION] |
                                 --retrieve-genotype [RETRIEVE_GENOTYPE])
                                 [--infer-nocall | --infer-ref] [--sql]
                                 [-o OUTPUT]
                                 path

Query a Dataset or Cohort for an instance of a germline variant assay and
retrieve data, or generate SQL to retrieve data, as defined by user-provided
filters.

positional arguments:
  path                  v3.0 Dataset or Cohort object ID (project-id:record-
                        id, where ":record-id" indicates the record-id in the
                        currently selected project) or name.

options:
  -h, --help            show this help message and exit
  --assay-name ASSAY_NAME
                        Specify the genetic variant assay to query. If the
                        argument is not specified, the default assay used is
                        the first assay listed when using the argument, "--
                        list-assays."
  --list-assays         List genetic variant assays available for query in the
                        specified Dataset or Cohort object.
  --retrieve-allele [RETRIEVE_ALLELE]
                        A JSON object, either in a file (.json extension) or
                        as a string (‘<JSON object>’), specifying criteria of
                        alleles to retrieve. Returns a list of allele IDs with
                        additional information. Use --json-help with this
                        option to get detailed information on the JSON format
                        and filters
  --retrieve-annotation [RETRIEVE_ANNOTATION]
                        A JSON object, either in a file (.json extension) or
                        as a string (‘<JSON object>’), specifying criteria to
                        retrieve corresponding alleles and their annotation.
                        Use --json-help with this option to get detailed
                        information on the JSON format and filters.
  --retrieve-genotype [RETRIEVE_GENOTYPE]
                        A JSON object, either in a file (.json extension) or
                        as a string (‘<JSON object>’), specifying criteria of
                        samples to retrieve. Returns a list of genotypes and
                        associated sample IDs and allele IDs. Genotype types
                        "ref" and "no-call" have no allele ID, and "half"
                        types where the genotype is half reference and half
                        no-call also have no allele ID. All other genotype
                        types have an allele ID, including "half" types where
                        the genotype is half alternate allele and half no-
                        call. Use --json-help with this option to get detailed
                        information on the JSON format and filters.
  --infer-nocall        When using the "--retrieve-genotype" option, infer
                        genotypes with type "no-call" if they were excluded
                        when the dataset was created. This option is only
                        valid if the exclusion parameters at ingestion were
                        set to "exclude_nocall=true", "exclude_halfref=false",
                        and "exclude_refdata=false".
  --infer-ref           When using the "--retrieve-genotype" option, infer
                        genotypes with type "ref" if they were excluded when
                        the dataset was created. This option is only valid if
                        the exclusion parameters at ingestion were set to
                        "exclude_nocall=false", "exclude_halfref=false", and
                        "exclude_refdata=true".
  --sql                 If the flag is provided, a SQL statement, returned as
                        a string, will be provided to query the specified data
                        instead of returning data.
  -o, --output OUTPUT   A local filename or directory to be used, where "-"
                        indicates printing to STDOUT. If -o/--output is not
                        supplied, default behavior is to create a file with a
                        constructed name in the current folder.

`extract_assay somatic`

usage: dx extract_assay somatic [-h] (--list-assays | --retrieve-meta-info |
                                --retrieve-variant [RETRIEVE_VARIANT] |
                                --additional-fields-help)
                                [--include-normal-sample]
                                [--additional-fields ADDITIONAL_FIELDS]
                                [--assay-name ASSAY_NAME] [--sql] [-o OUTPUT]
                                path

Query a Dataset or Cohort for an instance of a somatic variant assay and
retrieve data, or generate SQL to retrieve data, as defined by user-provided
filters.

positional arguments:
  path                  v3.0 Dataset or Cohort object ID (project-id:record-
                        id, where ":record-id" indicates the record-id in the
                        currently selected project) or name.

options:
  -h, --help            show this help message and exit
  --list-assays         List somatic variant assays available for query in the
                        specified Dataset or Cohort object.
  --retrieve-meta-info  List meta information, as it exists in the original
                        VCF headers for both INFO and FORMAT fields.
  --retrieve-variant [RETRIEVE_VARIANT]
                        A JSON object, either in a file (.json extension) or
                        as a string (‘<JSON object>’), specifying criteria of
                        somatic variants to retrieve. Retrieves rows from the
                        variant table, optionally extended with sample and
                        annotation information (the extension is inline
                        without affecting row count). By default returns the
                        following set of fields; "assay_sample_id",
                        "allele_id", "CHROM", "POS", "REF", and "allele".
                        Additional fields may be returned using --additional-
                        fields. Use --json-help with this option to get
                        detailed information on the JSON format and filters.
                        When filtering, the user must supply one, and only one
                        of "location", "annotation.symbol", "annotation.gene",
                        "annotation.feature", "allele.allele_id".
  --additional-fields-help
                        List all fields available for output.
  --include-normal-sample
                        Include variants associated with normal samples in the
                        assay. If no flag is supplied, variants from normal
                        samples will not be supplied.
  --additional-fields ADDITIONAL_FIELDS
                        A set of fields to return, in addition to the default
                        set; "assay_sample_id", "allele_id", "CHROM", "POS",
                        "REF", "allele". Fields must be represented as field
                        names and supplied as a single string, where each
                        field name is separated by a single comma. For
                        example, "fieldA,fieldB,fieldC." Internal spaces are
                        permitted. Use --additional-fields-help with this
                        option to get detailed information and the full list
                        of output fields available.
  --assay-name ASSAY_NAME
                        Specify the somatic variant assay to query. If the
                        argument is not specified, the default assay used is
                        the first assay listed when using the argument, "--
                        list-assays."
  --sql                 If the flag is provided, a SQL statement, returned as
                        a string, will be provided to query the specified data
                        instead of returning data.
  -o, --output OUTPUT   A local filename or directory to be used, where "-"
                        indicates printing to STDOUT. If -o/--output is not
                        supplied, default behavior is to create a file with a
                        constructed name in the current folder.

Manage metadata

Category: metadata in dx help

`set_details`

usage: dx set_details [-h] [--env-help] [-a] [-f DETAILS_FILE] path [details]

Set the JSON details of a data object.

positional arguments:
  path                  ID or path to data object to modify
  details               JSON to store as details

options:
  -h, --help            show this help message and exit
  --env-help            Display help message for overriding environment
                        variables
  -a, --all             Apply to all results with the same name without
                        prompting
  -f, --details-file DETAILS_FILE
                        Path to local file containing JSON to store as details

`get_details`

`set_visibility`

usage: dx set_visibility [-h] [--env-help] [-a] path {hidden,visible}

Set visibility on a data object.

positional arguments:
  path              ID or path to data object to modify
  {hidden,visible}  Visibility that the object should have

options:
  -h, --help        show this help message and exit
  --env-help        Display help message for overriding environment variables
  -a, --all         Apply to all results with the same name without prompting

`add_types`

usage: dx add_types [-h] [--env-help] [-a] path type [type ...]

Add types to a data object. See
https://documentation.dnanexus.com/developer/api/data-object-lifecycle/types
for a list of DNAnexus types.

positional arguments:
  path        ID or path to data object to modify
  type        Types to add

options:
  -h, --help  show this help message and exit
  --env-help  Display help message for overriding environment variables
  -a, --all   Apply to all results with the same name without prompting

`remove_types`

usage: dx remove_types [-h] [--env-help] [-a] path type [type ...]

Remove types from a data object. See
https://documentation.dnanexus.com/developer/api/data-object-lifecycle/types
for a list of DNAnexus types.

positional arguments:
  path        ID or path to data object to modify
  type        Types to remove

options:
  -h, --help  show this help message and exit
  --env-help  Display help message for overriding environment variables
  -a, --all   Apply to all results with the same name without prompting

`tag`

`untag`

`rename`

`set_properties`

`unset_properties`

Build and modify workflows

Category: workflow in dx help

`add stage`

usage: dx add stage [-h] [-i INPUT] [-j INPUT_JSON] [-f FILENAME] [--brief |
                    --verbose] [--env-help]
                    [--instance-type INSTANCE_TYPE_OR_MAPPING]
                    [--instance-type-by-executable DOUBLE_MAPPING]
                    [--instance-type-help] [--alias ALIAS] [--name NAME]
                    [--id STAGE_ID] [--output-folder OUTPUT_FOLDER |
                    --relative-output-folder RELATIVE_OUTPUT_FOLDER]
                    workflow executable

Add a stage to a workflow. Default inputs for the stage can also be set at the
same time.

positional arguments:
  workflow              Name or ID of a workflow
  executable            Name or ID of an executable to add as a stage in the
                        workflow

options:
  -h, --help            show this help message and exit
  -i, --input INPUT     An input to be added using "<input
                        name>[:<class>]=<input value>" (provide "class" if
                        there is no input spec; it can be any job IO class,
                        e.g. "string", "array:string", or "array"; if "class"
                        is "array" or not specified, the value will be
                        attempted to be parsed as JSON and is otherwise
                        treated as a string)
  -j, --input-json INPUT_JSON
                        The full input JSON (keys=input field names,
                        values=input field values)
  -f, --input-json-file FILENAME
                        Load input JSON from FILENAME ("-" to use stdin)
  --brief               Display a brief version of the return value; for most
                        commands, prints a DNAnexus ID per line
  --verbose             If available, displays extra verbose output
  --env-help            Display help message for overriding environment
                        variables
  --instance-type INSTANCE_TYPE_OR_MAPPING
                        When running an app or applet, the mapping lists
                        executable's entry points or "*" as keys, and instance
                        types to use for these entry points as values. When
                        running a workflow, the specified instance types can
                        be prefixed by a stage name or stage index followed by
                        "=" to apply to a specific stage, or apply to all
                        workflow stages without such prefix. The instance type
                        corresponding to the "*" key is applied to all entry
                        points not explicitly mentioned in the --instance-type
                        mapping. Specifying a single instance type is
                        equivalent to using it for all entry points, so "--
                        instance-type mem1_ssd1_v2_x2" is same as "--instance-
                        type '{"*":"mem1_ssd1_v2_x2"}'. Note that "dx run"
                        calls within the execution subtree may override the
                        values specified at the root of the execution tree.
                        See dx run --instance-type-help for details.
  --instance-type-by-executable DOUBLE_MAPPING
                        Specifies instance types by app or applet id, then by
                        entry point within the executable. The order of
                        priority for this specification is: * --instance-type,
                        systemRequirements and stageSystemRequirements
                        specified at runtime * stage's systemRequirements,
                        systemRequirements supplied to /app/new and
                        /applet/new at workflow/app/applet build time *
                        systemRequirementsByExecutable specified in downstream
                        executions (if any) See dx run --instance-type-help
                        for details.
  --instance-type-help  Print help for specifying instance types
  --alias, --version, --tag ALIAS
                        Tag or version of the app to add if the executable is
                        an app (default: "default" if an app)
  --name NAME           Stage name
  --id STAGE_ID         Stage ID
  --output-folder OUTPUT_FOLDER
                        Path to the output folder for the stage (interpreted
                        as an absolute path)
  --relative-output-folder RELATIVE_OUTPUT_FOLDER
                        A relative folder path for the stage (interpreted as
                        relative to the workflow's output folder)

`remove stage`

`update stage`

`update workflow`

`list stages`

usage: dx list stages [-h] [--env-help] workflow

List the stages in a workflow.

positional arguments:
  workflow    Name or ID of a workflow

options:
  -h, --help  show this help message and exit
  --env-help  Display help message for overriding environment variables

Run and manage apps

Category: exec in dx help

Build and publish

`build`

`publish`

Manage app access

See also: invite and uninvite for project-level sharing.

`add`

`add users`

usage: dx add users [-h] [--env-help] app authorizedUser [authorizedUser ...]

Add users or orgs to the list of authorized users of an app. Published
versions of the app will only be accessible to users represented by this list
and to developers of the app. Unpublished versions are restricted to the
developers.

positional arguments:
  app             Name or ID of an app
  authorizedUser  One or more users or orgs to add

options:
  -h, --help      show this help message and exit
  --env-help      Display help message for overriding environment variables

`add developers`

usage: dx add developers [-h] [--env-help] app developer [developer ...]

Add users or orgs to the list of developers for an app. Developers are able to
build and publish new versions of the app, and add or remove others from the
list of developers and authorized users.

positional arguments:
  app         Name or ID of an app
  developer   One or more users or orgs to add

options:
  -h, --help  show this help message and exit
  --env-help  Display help message for overriding environment variables

`list`

usage: dx list [-h] list_type ...

Use this command with one of the availabile subcommands to perform various
actions such as printing the list of developers or authorized users of an app.

positional arguments:
  list_type
    users       List authorized users for an app
    developers  List developers for an app
    stages      List the stages in a workflow
    database    List entities associated with a specific database. For
                example, "dx list database files" lists database files
                associated with a specific database. Please execute "dx list
                database -h" for more information.

options:
  -h, --help    show this help message and exit

`list users`

`list developers`

usage: dx list developers [-h] [--env-help] app

List the developers for an app. Developers are able to build and publish new
versions of the app, and add or remove others from the list of developers and
authorized users.

positional arguments:
  app         Name or ID of an app

options:
  -h, --help  show this help message and exit
  --env-help  Display help message for overriding environment variables

`remove`

`remove users`

`remove developers`

usage: dx remove developers [-h] [--env-help] app developer [developer ...]

Remove users or orgs from the list of developers for an app. Developers are
able to build and publish new versions of the app, and add or remove others
from the list of developers and authorized users.

positional arguments:
  app         Name or ID of an app
  developer   One or more users to remove

options:
  -h, --help  show this help message and exit
  --env-help  Display help message for overriding environment variables

`install`

usage: dx install [-h] [--env-help] app

Install an app by name. To see a list of apps you can install, hit <TAB> twice
after "dx install" or run "dx find apps" to see a list of available apps.

positional arguments:
  app         ID or name of app to install

options:
  -h, --help  show this help message and exit
  --env-help  Display help message for overriding environment variables

`uninstall`

usage: dx uninstall [-h] [--env-help] app

Uninstall an app by name.

positional arguments:
  app         ID or name of app to uninstall

options:
  -h, --help  show this help message and exit
  --env-help  Display help message for overriding environment variables

Run and monitor

`run`

See also: watch, terminate, find jobs

usage: dx run [-i INPUT] [-j INPUT_JSON] [-f FILENAME] [--brief | --verbose]
              [--env-help] [--extra-args EXTRA_ARGS]
              [--instance-type INSTANCE_TYPE_OR_MAPPING]
              [--instance-type-by-executable DOUBLE_MAPPING]
              [--instance-type-help] [--property KEY=VALUE] [--tag TAG]
              [-d DEPENDS_ON] [-h] [--clone CLONE] [--alias ALIAS]
              [--destination PATH] [--batch-folders] [--project PROJECT]
              [--stage-output-folder STAGE_ID FOLDER]
              [--stage-relative-output-folder STAGE_ID FOLDER] [--name NAME]
              [--delay-workspace-destruction] [--priority {low,normal,high}]
              [--head-job-on-demand] [-y] [--wait] [--watch]
              [--allow-ssh [ADDRESS]] [--ssh] [--ssh-proxy <address>:<port>]
              [--debug-on {AppError,AppInternalError,ExecutionError,All}]
              [--ignore-reuse | --ignore-reuse-stage STAGE_ID]
              [--rerun-stage STAGE_ID] [--batch-tsv FILE]
              [--instance-count INSTANCE_COUNT_OR_MAPPING] [--input-help]
              [--detach] [--cost-limit cost_limit] [-r RANK]
              [--max-tree-spot-wait-time MAX_TREE_SPOT_WAIT_TIME]
              [--max-job-spot-wait-time MAX_JOB_SPOT_WAIT_TIME]
              [--detailed-job-metrics] [--preserve-job-outputs |
              --preserve-job-outputs-folder JOB_OUTPUTS_FOLDER]
              [executable]

Run an applet, app, or workflow.  To see a list of executables you can run,
hit <TAB> twice after "dx run" or run "dx find apps" or "dx find
globalworkflows" to see a list of available apps and global workflows.

If any inputs are required but not specified, an interactive mode for
selecting inputs will be launched.  Inputs can be set in multiple ways.  Run
"dx run --input-help" for more details.

Run "dx run --instance-type-help" to see a list of specifications for
computers available to run executables.

positional arguments:
  executable            Name or ID of an applet, app, or workflow to run; must
                        be provided if --clone is not set

options:
  -i, --input INPUT     An input to be added using "<input
                        name>[:<class>]=<input value>" (provide "class" if
                        there is no input spec; it can be any job IO class,
                        e.g. "string", "array:string", or "array"; if "class"
                        is "array" or not specified, the value will be
                        attempted to be parsed as JSON and is otherwise
                        treated as a string)
  -j, --input-json INPUT_JSON
                        The full input JSON (keys=input field names,
                        values=input field values)
  -f, --input-json-file FILENAME
                        Load input JSON from FILENAME ("-" to use stdin)
  --brief               Display a brief version of the return value; for most
                        commands, prints a DNAnexus ID per line
  --verbose             If available, displays extra verbose output
  --env-help            Display help message for overriding environment
                        variables
  --extra-args EXTRA_ARGS
                        Arguments (in JSON format) to pass to the underlying
                        API method, overriding the default settings
  --instance-type INSTANCE_TYPE_OR_MAPPING
                        When running an app or applet, the mapping lists
                        executable's entry points or "*" as keys, and instance
                        types to use for these entry points as values.  
                        When
                        running a workflow, the specified instance types can
                        be prefixed by a stage name or stage index followed by
                        "=" to apply to a specific stage, or apply to all
                        workflow stages without such prefix. 
                        The instance
                        type corresponding to the "*" key is applied to all
                        entry points not explicitly mentioned in the
                        --instance-type mapping. Specifying a single instance
                        type is equivalent to using it for all entry points,
                        so "--instance-type mem1_ssd1_v2_x2" is same as
                        "--instance-type '{"*":"mem1_ssd1_v2_x2"}'. 
                        Note that
                        "dx run" calls within the execution subtree may
                        override the values specified at the root of the
                        execution tree.
                        See dx run --instance-type-help for
                        details.
  --instance-type-by-executable DOUBLE_MAPPING
                        Specifies instance types by app or applet id, then by
                        entry point within the executable.
                        The order of
                        priority for this specification is:
                          *
                        --instance-type, systemRequirements and
                        stageSystemRequirements specified at runtime
                          *
                        stage's systemRequirements, systemRequirements
                        supplied to /app/new and /applet/new at
                        workflow/app/applet build time
                          *
                        systemRequirementsByExecutable specified in downstream
                        executions (if any)
                        See dx run --instance-type-help
                        for details.
  --instance-type-help  Print help for specifying instance types
  --property KEY=VALUE  Key-value pair to add as a property; repeat as
                        necessary,
                         e.g. "--property key1=val1 --property key2=val2"
  --tag TAG             Tag for the resulting execution; repeat as necessary,
                         e.g. "--tag tag1 --tag tag2"
  -d, --depends-on DEPENDS_ON
                        ID of job, analysis, or data object that must be in
                        the "done" or "closed" state, as appropriate, before
                        this executable can be run; repeat as necessary (e.g.
                        "--depends-on id1 ... --depends-on idN"). Cannot be
                        supplied when running workflows
  -h, --help            show this help message and exit
  --clone CLONE         Job or analysis ID or name from which to use as
                        default options (will use the exact same executable
                        ID, destination project and folder, job input,
                        instance type requests, and a similar name unless
                        explicitly overridden by command-line arguments. When
                        using an analysis with --clone a workflow executable
                        cannot be overriden and should not be provided.)
  --alias, --version ALIAS
                        Alias (tag) or version of the app to run (default:
                        "default" if an app)
  --destination, --folder PATH
                        The full project:folder path in which to output the
                        results. By default, the current working directory
                        will be used.
  --batch-folders       Output results to separate folders, one per batch,
                        using batch ID as the name of the output folder. The
                        batch output folder location will be relative to the
                        path set in --destination
  --project PROJECT     Project name or ID in which to run the executable.
                        This can also be specified together with the output
                        folder in --destination.
  --stage-output-folder STAGE_ID FOLDER
                        A stage identifier (ID, name, or index), and a folder
                        path to use as its output folder
  --stage-relative-output-folder STAGE_ID FOLDER
                        A stage identifier (ID, name, or index), and a
                        relative folder path to the workflow output folder to
                        use as the output folder
  --name NAME           Name for the job (default is the app or applet name)
  --delay-workspace-destruction
                        Whether to keep the job's temporary workspace around
                        for debugging purposes for 3 days after it succeeds or
                        fails
  --priority {low,normal,high}
                        Request a scheduling priority for all resulting jobs.
                        Defaults to high when --watch, --ssh, or --allow-ssh
                        flags are used.
  --head-job-on-demand  Requests that the head job of an app or applet be run
                        in an on-demand instance. Note that
                        --head-job-on-demand option will override the
                        --priority setting for the head job
  -y, --yes             Do not ask for confirmation
  --wait                Wait until the job is done before returning
  --watch               Watch the job after launching it. Defaults --priority to high.
  --allow-ssh [ADDRESS]
                        Configure the job to allow SSH access. Defaults
                        --priority to high. If an argument is supplied, it is
                        interpreted as an IP range, e.g. "--allow-ssh
                        1.2.3.4". If no argument is supplied then the client
                        IP visible to the DNAnexus API server will be used by
                        default
  --ssh                 Configure the job to allow SSH access and connect to
                        it after launching. Defaults --priority to high.
  --ssh-proxy <address>:<port>
                        SSH connect via proxy, argument supplied is used as
                        the proxy address and port
  --debug-on {AppError,AppInternalError,ExecutionError,All}
                        Configure the job to hold for debugging when any of
                        the listed errors occur
  --ignore-reuse        Disable job reuse for execution
  --ignore-reuse-stage STAGE_ID
                        A stage (using its ID, name, or index) for which job
                        reuse should be disabled, if a stage points to another
                        (nested) workflow the ignore reuse option will be
                        applied to the whole subworkflow. This option
                        overwrites any ignoreReuse fields set on app(let)s or
                        the workflow during build time; repeat as necessary
  --rerun-stage STAGE_ID
                        A stage (using its ID, name, or index) to rerun, or
                        "*" to indicate all stages should be rerun; repeat as
                        necessary
  --batch-tsv FILE      A file in tab separated value (tsv) format, with a
                        subset of the executable input arguments. A job will
                        be launched for each table row.
  --instance-count INSTANCE_COUNT_OR_MAPPING
                        Specify spark cluster instance count(s). It can be an
                        int or a mapping of the format '{"entrypoint": <number
                        of instances>}'
  --input-help          Print help and examples for how to specify inputs
  --detach              When invoked from a job, detaches the new job from the
                        creator job so the new job will appear as a typical
                        root execution. Setting DX_RUN_DETACH environment
                        variable to 1 causes this option to be set by default.
  --cost-limit cost_limit
                        Maximum cost of the job before termination. In case of
                        workflows it is cost of the entire analysis job. For
                        batch run, this limit is applied per job.
  -r, --rank RANK       Set the rank of the root execution, integer between
                        -1024 and 1023. Requires executionRankEnabled license
                        feature for the billTo. Default is 0.
  --max-tree-spot-wait-time MAX_TREE_SPOT_WAIT_TIME
                        The amount of time allocated to each path in the root
                        execution's tree to wait for Spot (in seconds, or use
                        suffix s, m, h, d, w, M, y)
  --max-job-spot-wait-time MAX_JOB_SPOT_WAIT_TIME
                        The amount of time allocated to each job in the root
                        execution's tree to wait for Spot (in seconds, or use
                        suffix s, m, h, d, w, M, y)
  --detailed-job-metrics
                        Collect CPU, memory, network and disk metrics every 60
                        seconds
  --preserve-job-outputs
                        Copy cloneable outputs of every non-reused job
                        entering "done" state in this root execution R into
                        the "intermediateJobOutputs" subfolder under R's
                        output folder.  As R's root job or root analysis'
                        stages complete, R's regular outputs will be moved to
                        R's regular output folder.
  --preserve-job-outputs-folder JOB_OUTPUTS_FOLDER
                        Similar to --preserve-job-outputs, copy cloneable
                        outputs of every non-reused job entering "done" state
                        in this root execution to the specified folder in the
                        project.  JOB_OUTPUTS_FOLDER starting with '/' refers
                        to an absolute path within the project, otherwise, it
                        refers to a subfolder under root execution's output
                        folder.

`run --input-help`

Help: Specifying input for dx run

There are several ways to specify inputs.  In decreasing order of precedence,
they are:

  1) inputs given in the interactive mode
  2) inputs listed individually with the -i/--input command line argument
  3) JSON given in --input-json
  4) JSON given in --input-json-file
  5) if cloning a job with --clone, the input that the job was run with
     (this will get overridden completely if -j/--input-json or
      -f/--input-json-file are provided)
  6) default values set in a workflow or an executable's input spec

SPECIFYING INPUTS BY NAME

  Use the -i/--input flag to specify each input field by name and value.

    Syntax :  -i<input name>=<input value>
    Example:  dx run myApp -inum=34 -istr=ABC -ifiles=reads1.fq.gz -ifiles=reads2.fq.gz

  The example above runs an app called "myApp" with 3 inputs called num (class
  int), str (class string), and files (class array:file).  (For this method to
  work, the app must have an input spec so inputs can be interpreted
  correctly.)  The same input field can be used multiple times if the input
  class is an array.

  Job-based object references can also be provided using the <job id>:<output
  name> syntax:

    Syntax :  -i<input name>=<job id>:<output name>
    Example:  dx run mapper -ireads=job-B0fbxvGY00j9jqGQvj8Q0001:reads

  You can extract an element of an array output using the <job id>:<output
  name>.<element> syntax:

    Syntax :  -i<input name>=<job id>:<output name>.<element>
    Example:  dx run mapper -ireadsfile=job-B0fbxvGY00j9jqGQvj8Q0001:reads.1
              # Extracts second element of array output

  When executing workflows, stage inputs can be specified using the <stage
  key>.<input name>=<value> syntax:

    Syntax :  -i<stage key>.<input name>=<input value>
    Example:  dx run my_workflow -i0.reads="My reads file"

<stage key> may be either the ID of the stage, name of the stage, or the
number of the stage in the workflow (0 indicates first stage)
  If the workflow has explicit, workflow-level inputs, input values must be
  passed to these workflow-level input fields using the <workflow input
  name>=<value> syntax:

    Syntax :  -i<workflow input name>=<input value>
    Example:  dx run my_workflow -ireads="My reads file"

SPECIFYING JSON INPUT

  JSON input can be used directly using the -j/--input-json or
  -f/--input-json-file flags.  When running an app or applet, the keys should
  be the input field names for the app or applet.  When running a workflow,
  the keys should be the input field names for each stage, prefixed by the
  stage key and a period, e.g. "my_stage.reads" for the "reads" input of stage
  "my_stage".

`run --instance-type-help`

Help: Specifying instance types for dx run

Instance types can be requested with --instance-type-by-executable and
--instance-type arguments, with --instance-type-by-executable specification
taking priority over --instance-type, workflow's stageSystemRequirements, and
specifications provided during app and applet creation.

--instance-type specifications do not propagate to subjobs and sub-analyses
launched from a job with a /executable-xxxx/run call, but
--instance-type-by-executable do (where executable refers to an app, applet or
workflow).

When running an app or an applet, --instance-type lets you specify the
instance type to be used by each entry point.
A single instance type can be requested to be used by all entry points by
providing the instance type name.  Different instance types can also be
requested for different entry points of an app or applet by providing a JSON
string mapping from function names to instance types, e.g.

    {"main": "mem2_hdd2_v2_x2", "other_function": "mem1_ssd1_v2_x2"}

When running a workflow, --instance-type lets you specify instance types for
each entry point of each workflow stage by prepending the request with "<stage
identifier>=" (where a stage identifier is an ID, a numeric index, or a unique
stage name) and repeating the argument for as many stages as desired.  If no
stage identifier is provided, the value is applied as a default for all
stages.

Examples

1. Run the main entry point of applet-xxxx on mem1_ssd1_v2_x2, and all other
entry points on mem1_ssd1_v2_x4
    dx run applet-xxxx --instance-type '{"main": "mem1_ssd1_v2_x2",
                                         "*":    "mem1_ssd1_v2_x4"}'

2. Runs all entry points of the first stage with mem2_hdd2_v2_x2, the main
entry point of the second stage with mem1_ssd1_v2_x4, the stage named "BWA"
with mem1_ssd1_v2_x2, and all other stages with mem2_hdd2_v2_x4

    dx run workflow-xxxx \
     --instance-type 0=mem2_hdd2_v2_x2 \
     --instance-type 1='{"main": "mem1_ssd1_v2_x4"}' \
     --instance-type BWA=mem1_ssd1_v2_x2 \
     --instance-type mem2_hdd2_v2_x4

--instance-type-by-executable argument is a JSON string with a double mapping
that specifies instance types by app or applet id, then by entry point within
the executable.This specification applies across the entire nested execution
tree and is propagated across /executable-xxxx/run calls issued with the
execution tree.

More examples
3. Force every job in the execution tree to use mem2_ssd1_v2_x2

    dx run workflow-xxxx --instance-type-by-executable '{"*": {"*": "mem2_ssd1_v2_x2"}}'

4. Force every job in the execution tree executing applet-xyz1 to use
mem2_ssd1_v2_x2

    dx run workflow-xxxx --instance-type-by-executable '{"applet-xyz1":{"*": "mem2_ssd1_v2_x2"}}'

5. Force every job executing applet-xyz1 to use mem2_ssd1_v2_x4 for the main
entry point and mem2_ssd1_v2_x2 for all other entry points.Also force the
collect entry point of all executables other than applet-xyz1 to use
mem2_ssd1_v2_x8.Other entry points of executable other than applet-xyz1 may be
overridden by lower-priority mechanisms

    dx run workflow-xxxx --instance-type-by-executable \
           '{"applet-xyz1":  {"main":    "mem2_ssd1_v2_x4", "*": "mem2_ssd1_v2_x2"},
             "*":            {"collect": "mem2_ssd1_v2_x8"}}'

6. Force every job executing applet-xxxx to use mem2_ssd1_v2_x2 for all entry
points in the entire execution tree. Also force stage 0 executable to run on
mem2_ssd1_v2_x4, unless stage 0 invokes applet-xxxx, in which case
applet-xxxx's jobs will use mem2_ssd1_v2_x2 as specified by
--instance-type-by-executable.

    dx run workflow-xxxx \
     --instance-type-by-executable  '{"applet-xxxx": {"*": "mem2_ssd1_v2_x2"}}' \
     --instance-type 0=mem2_ssd1_v2_x4

See "Requesting Instance Types" in DNAnexus documentation for more details.

Available instance types:

┌────────────────────┬─────────┬──────────┬──────────┐
│Name                │CPU_Cores│Memory_GiB│Storage_GB│
├────────────────────┼─────────┼──────────┼──────────┤
│mem1_ssd1_v2_x2     │2        │4.0       │50        │
│mem1_ssd1_v2_x4     │4        │8.0       │100       │
│mem1_ssd1_v2_x8     │8        │16.0      │200       │
│mem1_ssd1_v2_x16    │16       │32.0      │400       │
│mem1_ssd1_v2_x36    │36       │72.0      │900       │
│mem1_ssd1_v2_x72    │72       │144.0     │1800      │
│mem1_ssd2_v2_x2     │2        │4.0       │160       │
│mem1_ssd2_v2_x4     │4        │8.0       │320       │
│mem1_ssd2_v2_x8     │8        │16.0      │640       │
│mem1_ssd2_v2_x16    │16       │32.0      │1280      │
│mem1_ssd2_v2_x36    │36       │72.0      │2880      │
│mem1_ssd2_v2_x72    │72       │144.0     │5760      │
│mem2_ssd1_v2_x2     │2        │8.0       │75        │
│mem2_ssd1_v2_x4     │4        │16.0      │150       │
│mem2_ssd1_v2_x8     │8        │32.0      │300       │
│mem2_ssd1_v2_x16    │16       │64.0      │600       │
│mem2_ssd1_v2_x32    │32       │128.0     │1200      │
│mem2_ssd1_v2_x48    │48       │144.0     │1800      │
│mem2_ssd1_v2_x64    │64       │256.0     │2400      │
│mem2_ssd1_v2_x96    │96       │384.0     │3600      │
│mem2_ssd2_v2_x2     │2        │8.0       │160       │
│mem2_ssd2_v2_x4     │4        │16.0      │320       │
│mem2_ssd2_v2_x8     │8        │32.0      │640       │
│mem2_ssd2_v2_x16    │16       │64.0      │1280      │
│mem2_ssd2_v2_x32    │32       │128.0     │2560      │
│mem2_ssd2_v2_x48    │48       │192.0     │3840      │
│mem2_ssd2_v2_x64    │64       │256.0     │5120      │
│mem2_ssd2_v2_x96    │96       │384.0     │7480      │
│mem3_ssd1_v2_x2     │2        │16.0      │75        │
│mem3_ssd1_v2_x4     │4        │32.0      │150       │
│mem3_ssd1_v2_x8     │8        │64.0      │300       │
│mem3_ssd1_v2_x16    │16       │128.0     │600       │
│mem3_ssd1_v2_x32    │32       │256.0     │1200      │
│mem3_ssd1_v2_x48    │48       │384.0     │1800      │
│mem3_ssd1_v2_x64    │64       │512.0     │3200      │
│mem3_ssd1_v2_x96    │96       │768.0     │3600      │
│mem3_ssd2_v2_x2     │2        │15.25     │475       │
│mem3_ssd2_v2_x4     │4        │30.5      │950       │
│mem3_ssd2_v2_x8     │8        │61.0      │1900      │
│mem3_ssd2_v2_x16    │16       │122.0     │3800      │
│mem3_ssd2_v2_x32    │32       │244.0     │7600      │
│mem3_ssd2_v2_x64    │64       │488.0     │15200     │
│mem3_ssd3_x2        │2        │16.0      │1250      │
│mem3_ssd3_x4        │4        │32.0      │2500      │
│mem3_ssd3_x8        │8        │64.0      │5000      │
│mem3_ssd3_x12       │12       │96.0      │7500      │
│mem3_ssd3_x24       │24       │192.0     │15000     │
│mem3_ssd3_x48       │48       │384.0     │30000     │
│mem3_ssd3_x96       │96       │768.0     │60000     │
│mem4_ssd1_x128      │128      │1952.0    │3840      │
│azure:mem1_ssd1_x2  │2        │3.9       │32        │
│azure:mem1_ssd1_x4  │4        │7.8       │64        │
│azure:mem1_ssd1_x8  │8        │15.7      │128       │
│azure:mem1_ssd1_x16 │16       │31.4      │256       │
│azure:mem2_ssd1_x1  │1        │3.5       │128       │
│azure:mem2_ssd1_x2  │2        │7.0       │128       │
│azure:mem2_ssd1_x4  │4        │14.0      │128       │
│azure:mem2_ssd1_x8  │8        │28.0      │256       │
│azure:mem2_ssd1_x16 │16       │56.0      │512       │
│azure:mem3_ssd1_x2  │2        │14.0      │128       │
│azure:mem3_ssd1_x4  │4        │28.0      │128       │
│azure:mem3_ssd1_x8  │8        │56.0      │256       │
│azure:mem3_ssd1_x16 │16       │112.0     │512       │
│azure:mem3_ssd1_x20 │20       │140.0     │640       │
│azure:mem4_ssd1_x2  │2        │28.0      │128       │
│azure:mem4_ssd1_x4  │4        │56.0      │128       │
│azure:mem4_ssd1_x8  │8        │112.0     │256       │
│azure:mem4_ssd1_x16 │16       │224.0     │512       │
│azure:mem4_ssd1_x32 │32       │448.0     │1024      │
│azure:mem5_ssd2_x64 │64       │1792.0    │8192      │
│azure:mem5_ssd2_x128│128      │3892.0    │16384     │
│mem1_ssd1_x2        │2        │3.8       │32        │
│mem1_ssd1_x4        │4        │7.5       │80        │
│mem1_ssd1_x8        │8        │15.0      │160       │
│mem1_ssd1_x16       │16       │30.0      │320       │
│mem1_ssd1_x32       │32       │60.0      │640       │
│mem1_ssd2_x2        │2        │3.8       │160       │
│mem1_ssd2_x4        │4        │7.5       │320       │
│mem1_ssd2_x8        │8        │15.0      │640       │
│mem1_ssd2_x16       │16       │30.0      │1280      │
│mem1_ssd2_x36       │36       │60.0      │2880      │
│mem2_ssd1_x2        │2        │7.5       │32        │
│mem2_ssd1_x4        │4        │15.0      │80        │
│mem2_ssd1_x8        │8        │30.0      │160       │
│mem2_ssd2_x2        │2        │8.0       │160       │
│mem2_ssd2_x4        │4        │16.0      │320       │
│mem2_ssd2_x8        │8        │32.0      │1280      │
│mem2_ssd2_x16       │16       │64.0      │2560      │
│mem2_ssd2_x40       │40       │160.0     │3200      │
│mem2_ssd2_x64       │64       │256.0     │5120      │
│mem3_ssd1_x2        │2        │15.0      │32        │
│mem3_ssd1_x4        │4        │30.5      │80        │
│mem3_ssd1_x8        │8        │61.0      │160       │
│mem3_ssd1_x16       │16       │122.0     │320       │
│mem3_ssd1_x32       │32       │244.0     │640       │
│mem3_ssd2_x4        │4        │30.5      │800       │
│mem3_ssd2_x8        │8        │61.0      │1600      │
│mem3_ssd2_x16       │16       │122.0     │3200      │
│mem3_ssd2_x32       │32       │244.0     │6400      │
│mem1_hdd1_x2        │2        │3.75      │200       │
│mem1_hdd1_x4        │4        │7.5       │400       │
│mem1_hdd1_x8        │8        │15.0      │800       │
│mem1_hdd1_x16       │16       │30.0      │1600      │
│mem1_hdd1_x36       │36       │60.0      │3200      │
│mem1_hdd1_v2_x2     │2        │4.0       │200       │
│mem1_hdd1_v2_x4     │4        │8.0       │400       │
│mem1_hdd1_v2_x8     │8        │16.0      │800       │
│mem1_hdd1_v2_x16    │16       │32.0      │1600      │
│mem1_hdd1_v2_x36    │36       │72.0      │3600      │
│mem1_hdd1_v2_x72    │72       │144.0     │7200      │
│mem1_hdd1_v2_x96    │96       │192.0     │9600      │
│mem1_hdd2_x1        │1        │1.7       │160       │
│mem1_hdd2_x8        │8        │7.0       │1680      │
│mem1_hdd2_x32       │32       │60.5      │3360      │
│mem2_hdd2_x1        │1        │3.8       │410       │
│mem2_hdd2_x2        │2        │7.5       │840       │
│mem2_hdd2_x4        │4        │15.0      │1680      │
│mem2_hdd2_v2_x2     │2        │8.0       │1000      │
│mem2_hdd2_v2_x4     │4        │16.0      │2000      │
│mem3_hdd2_v2_x2     │2        │16.0      │500       │
│mem3_hdd2_v2_x4     │4        │32.0      │1000      │
│mem3_hdd2_v2_x8     │8        │64.0      │2000      │
└────────────────────┴─────────┴──────────┴──────────┘

GPU instance types:

┌────────────────────────┬─────────┬──────────┬──────────┬─────────────┬──────────────┐
│Name                    │CPU_Cores│Memory_GiB│Storage_GB│GPU          │GPU_Memory_GiB│
├────────────────────────┼─────────┼──────────┼──────────┼─────────────┼──────────────┤
│mem2_ssd1_gpu_x16       │16       │64.0      │225       │1 NVIDIA T4  │16.0          │
│mem2_ssd1_gpu_x32       │32       │128.0     │900       │1 NVIDIA T4  │16.0          │
│mem2_ssd1_gpu1_x32      │32       │128.0     │900       │1 NVIDIA T4  │16.0          │
│mem2_ssd1_gpu_x64       │64       │256.0     │900       │1 NVIDIA T4  │16.0          │
│mem2_ssd1_gpu1_x64      │64       │256.0     │900       │1 NVIDIA T4  │16.0          │
│mem2_ssd1_gpu_x48       │48       │192.0     │900       │4 NVIDIA T4  │64.0          │
│mem2_ssd1_gpu4_x48      │48       │192.0     │900       │4 NVIDIA T4  │64.0          │
│mem2_ssd2_gpu1_x4       │4        │16.0      │250       │1 NVIDIA A10G│24.0          │
│mem2_ssd2_gpu1_x8       │8        │32.0      │450       │1 NVIDIA A10G│24.0          │
│mem2_ssd2_gpu1_x16      │16       │64.0      │600       │1 NVIDIA A10G│24.0          │
│mem2_ssd2_gpu1_x32      │32       │128.0     │900       │1 NVIDIA A10G│24.0          │
│mem2_ssd2_gpu1_x64      │64       │256.0     │1900      │1 NVIDIA A10G│24.0          │
│mem2_ssd2_gpu4_x48      │48       │192.0     │3800      │4 NVIDIA A10G│96.0          │
│mem2_ssd2_gpu4_x96      │96       │384.0     │3800      │4 NVIDIA A10G│96.0          │
│mem2_ssd2_gpu8_x192     │192      │768.0     │7600      │8 NVIDIA A10G│192.0         │
│mem2_ssd2_gpu1_v2_x4    │4        │16.0      │250       │1 NVIDIA L4  │24.0          │
│mem2_ssd2_gpu1_v2_x8    │8        │32.0      │450       │1 NVIDIA L4  │24.0          │
│mem2_ssd2_gpu1_v2_x16   │16       │64.0      │600       │1 NVIDIA L4  │24.0          │
│mem2_ssd2_gpu1_v2_x32   │32       │128.0     │900       │1 NVIDIA L4  │24.0          │
│mem2_ssd2_gpu1_v2_x64   │64       │256.0     │1880      │1 NVIDIA L4  │24.0          │
│mem2_ssd2_gpu4_v2_x48   │48       │192.0     │3760      │4 NVIDIA L4  │96.0          │
│mem2_ssd2_gpu4_v2_x96   │96       │384.0     │3760      │4 NVIDIA L4  │96.0          │
│mem2_ssd2_gpu8_v2_x192  │192      │768.0     │7520      │8 NVIDIA L4  │192.0         │
│mem3_ssd1_gpu1_x16      │16       │128.0     │600       │1 NVIDIA L4  │24.0          │
│mem3_ssd1_gpu1_x32      │32       │256.0     │900       │1 NVIDIA L4  │24.0          │
│mem3_ssd1_gpu_x8        │8        │61.0      │160       │1 NVIDIA V100│16.0          │
│mem3_ssd1_gpu_x32       │32       │244.0     │640       │4 NVIDIA V100│64.0          │
│mem3_ssd1_gpu_x64       │64       │488.0     │1280      │8 NVIDIA V100│128.0         │
│azure:mem3_ssd2_gpu4_x64│64       │488.0     │2048      │4 NVIDIA V100│64.0          │
└────────────────────────┴─────────┴──────────┴──────────┴─────────────┴──────────────┘

FPGA instance types:

┌────────────────────┬─────────┬──────────┬──────────┬────┐
│Name                │CPU_Cores│Memory_GiB│Storage_GB│FPGA│
├────────────────────┼─────────┼──────────┼──────────┼────┤
│mem3_ssd2_fpga1_x24 │24       │256.0     │940       │1   │
│mem3_ssd2_fpga1_x48 │48       │512.0     │1880      │2   │
│mem3_ssd2_fpga1_x192│192      │2048.0    │7520      │8   │
└────────────────────┴─────────┴──────────┴──────────┴────┘

`watch`

See also: run, terminate, describe

usage: dx watch [-h] [--env-help] [--color {off,on,auto}]
                [-n NUM_RECENT_MESSAGES] [--tree | --try T]
                [-l {EMERG,ALERT,CRITICAL,ERROR,WARNING,NOTICE,INFO,DEBUG,STDERR,STDOUT,METRICS}]
                [--get-stdout] [--get-stderr] [--get-streams]
                [--no-timestamps] [--job-ids] [--no-job-info] [-q] [-f FORMAT]
                [--no-wait] [--metrics {interspersed,none,top,csv}]
                [--metrics-help]
                jobid

Monitors logging output from a running or finished job

positional arguments:
  jobid                 ID of the job to watch

options:
  -h, --help            show this help message and exit
  --env-help            Display help message for overriding environment
                        variables
  --color {off,on,auto}
                        Set when color is used (color=auto is used when stdout
                        is a TTY)
  -n, --num-recent-messages NUM_RECENT_MESSAGES
                        Number of recent messages to get
  --tree                Include the entire job tree
  --try T               Allows to watch older tries of a restarted job. T=0
                        refers to the first try. Default is the last job try.
  -l, --levels {EMERG,ALERT,CRITICAL,ERROR,WARNING,NOTICE,INFO,DEBUG,STDERR,STDOUT,METRICS}
  --get-stdout          Extract stdout only from this job
  --get-stderr          Extract stderr only from this job
  --get-streams         Extract only stdout and stderr from this job
  --no-timestamps       Omit timestamps from messages
  --job-ids             Print job ID in each message
  --no-job-info         Omit job info and status updates
  -q, --quiet           Do not print extra info messages
  -f, --format FORMAT   Message format. Available fields: job, try, level,
                        msg, date
  --no-wait, --no-follow
                        Exit after the first new message is received, instead
                        of waiting for all logs
  --metrics {interspersed,none,top,csv}
                        Select display mode for detailed job metrics if they
                        were collected and are available based on retention
                        policy; see --metrics-help for details
  --metrics-help        Print help for displaying detailed job metrics

`watch --metrics-help`

Help: Displaying detailed job metrics
Detailed job metrics describe job's consumption of CPU, memory, disk, network, etc at 60 second intervals.
If collection of job metrics was enabled for a job (e.g with dx run --detailed-job-metrics), the metrics can be displayed by "dx watch" for 15 days from the time the job started running.

Note that all reported data-related values are in base 2 units - i.e. 1 MB = 1024 * 1024 bytes.

The "interspersed" default mode shows METRICS job log messages interspersed with other jog log messages.

The "none" mode omits all METRICS messages from "dx watch" output.

The "top" mode interactively shows the latest METRICS message at the top of the screen and updates it for running jobs instead of showing every METRICS message interspersed with the currently-displayed job log messages. For completed jobs, this mode does not show any metrics. Built-in help describing key bindings is available by pressing "?".

The "csv" mode outputs the following columns with headers in csv format to stdout:
- timestamp: An integer number representing the number of milliseconds since the Unix epoch.
- cpuCount: A number of CPUs available on the instance that ran the job.
- cpuUsageUser: The percentage of cpu time spent in user mode on the instance during the metric collection period.
- cpuUsageSystem: The percentage of cpu time spent in system mode on the instance during the metric collection period.
- cpuUsageIowait: The percentage of cpu time spent in waiting for I/O operations to complete on the instance during the metric collection period.
- cpuUsageIdle: The percentage of cpu time spent in waiting for I/O operations to complete on the instance during the metric collection period.
- memoryUsedBytes: Bytes of memory used (calculated as total - free - buffers - cache - slab_reclaimable + shared_memory).
- memoryTotalBytes: Total memory available on the instance that ran the job.
- diskUsedBytes: Bytes of storage allocated to the AEE that are used by the filesystem.
- diskTotalBytes: Total bytes of disk space available to the job within the AEE.
- networkOutBytes: Total network bytes transferred out from AEE since the job started. Includes "dx upload" bytes.
- networkInBytes: Total network bytes transferred into AEE since the job started. Includes "dx download" bytes.
- diskReadBytes: Total bytes read from the AEE-accessible disks since the job started.
- diskWriteBytes: Total bytes written to the AEE-accessible disks since the job started.
- diskReadOpsCount: Total disk read operation count against AEE-accessible disk since the job started.
- diskWriteOpsCount: Total disk write operation count against AEE-accessible disk since the job started.

Note 1: cpuUsageUser, cpuUsageSystem, cpuUsageIowait, cpuUsageIdle and memoryUsedBytes metrics reflect usage by processes inside and outside of the AEE which include DNAnexus services responsible for proxying DNAnexus data.
Note 2: cpuUsageUser + cpuUsageSystem + cpuUsageIowait + cpuUsageIdle + cpuUsageSteal = 100. cpuUsageSteal is unreported, but can be derived from the other 4 quantities given that they add up to 100.
Note 3: cpuUsage numbers are rounded to 2 decimal places.
Note 4: networkOutBytes may be larger than job's egressReport which does not include "dx upload" bytes.

The format of METRICS job log lines is defined as follows using the example below:

2023-03-15 12:23:44 some-job-name METRICS ** CPU usr/sys/idl/wai: 24/11/1/64% (4 cores) * Memory: 1566/31649MB * Storage: 19/142GB * Net: 10↓/0↑MBps * Disk: r/w 20/174 MBps iops r/w 8/1300

"2023-03-15 12:23:44" is the metrics collection time.
"METRICS" is a type of job log line containing detailed job metrics.
"CPU usr/sys/idl/wai: 24/11/1/64%" maps to cpuUsageUser, cpuUsageSystem, cpuUsageIdle, cpuUsageIowait values.
"(4 cores)" maps to cpuCount.
"Memory: 1566/31649MB" maps to memoryUsedBytes and memoryTotalBytes.
"Storage: 19/142GB" maps to diskUsedBytes and diskTotalBytes.
"Net: 10↓/0↑MBps" is derived from networkOutBytes and networkInBytes cumulative totals by subtracting previous measurement from the measurement at the metric collection time, and dividing the difference by the time span between the two measurements.
"Disk: r/w 20/174 MBps iops r/w 8/1300" is derived similar to "Net:" from diskReadBytes, diskWriteBytes, diskReadOpsCount, and diskWriteOpsCount.

`terminate`

`ssh`

`ssh_config`

Search for executables and executions

`find`

usage: dx find [-h] category ...

Search functionality over various DNAnexus entities.

positional arguments:
  category
    apps             List available apps
    globalworkflows  List available global workflows
    jobs             List jobs in the current project
    analyses         List analyses in the current project
    executions       List executions (jobs and analyses) in the current project
    data             List data objects in the current project
    projects         List projects
    org              List entities within a specific org.
                     
                     	"dx find org members" lists members in the specified org
                     
                     	"dx find org projects" lists projects billed to the specified org
                     
                     	"dx find org apps" lists apps billed to the specified org
                     
                     Please execute "dx find org -h" for more information.
    orgs             List orgs

options:
  -h, --help         show this help message and exit

`find apps`

usage: dx find apps [-h] [--brief | --verbose] [--json]
                    [--delimiter [DELIMITER]] [--env-help] [--name NAME]
                    [--category CATEGORY] [--category-help] [-a]
                    [--unpublished] [--installed] [--billed-to BILLED_TO]
                    [--creator CREATOR] [--developer DEVELOPER]
                    [--created-after CREATED_AFTER]
                    [--created-before CREATED_BEFORE] [--mod-after MOD_AFTER]
                    [--mod-before MOD_BEFORE]

Finds apps subject to the given search parameters. Use --category to restrict
by a category; common categories are available as tab completions and can be
listed with --category-help.

options:
  -h, --help            show this help message and exit
  --brief               Display a brief version of the return value; for most
                        commands, prints a DNAnexus ID per line
  --verbose             If available, displays extra verbose output
  --json                Display return value in JSON
  --delimiter, --delim [DELIMITER]
                        Always use exactly one of DELIMITER to separate fields
                        to be printed; if no delimiter is provided with this
                        flag, TAB will be used
  --env-help            Display help message for overriding environment
                        variables
  --name NAME           Name of the app
  --category CATEGORY   Category of the app
  --category-help       Print a list of common app categories
  -a, --all             Return all versions of each app
  --unpublished         Return only unpublished apps (if omitted, returns only
                        published apps)
  --installed           Return only installed apps
  --billed-to BILLED_TO
                        User or organization responsible for the app
  --creator CREATOR     Creator of the app version
  --developer DEVELOPER
                        Developer of the app
  --created-after CREATED_AFTER
                        Date (e.g. --created-after="2021-12-01" or --created-
                        after="2021-12-01 19:01:33") or integer Unix epoch
                        timestamp in milliseconds (e.g. --created-
                        after=1642196636000) after which the app created. You
                        can also specify negative numbers to indicate a time
                        period in the past suffixed by s, m, h, d, w, M or y
                        to indicate seconds, minutes, hours, days, weeks,
                        months or years (e.g. --created-after=-2d for apps
                        created in the last 2 days)
  --created-before CREATED_BEFORE
                        Date (e.g. --created-before="2021-12-01" or --created-
                        before="2021-12-01 19:01:33") or integer Unix epoch
                        timestamp in milliseconds (e.g. --created-
                        before=1642196636000) before which the app was
                        created. You can also specify negative numbers to
                        indicate a time period in the past suffixed by s, m,
                        h, d, w, M or y to indicate seconds, minutes, hours,
                        days, weeks, months or years (e.g. --created-
                        before=-2d for apps created earlier than 2 days ago)
  --mod-after MOD_AFTER
                        Date (e.g. --mod-after="2021-12-01" or --mod-
                        after="2021-12-01 19:01:33") or integer Unix epoch
                        timestamp in milliseconds (e.g. --mod-
                        after=1642196636000) after which the app modified. You
                        can also specify negative numbers to indicate a time
                        period in the past suffixed by s, m, h, d, w, M or y
                        to indicate seconds, minutes, hours, days, weeks,
                        months or years (e.g. --mod-after=-2d for apps
                        modified in the last 2 days)
  --mod-before MOD_BEFORE
                        Date (e.g. --mod-before="2021-12-01" or --mod-
                        before="2021-12-01 19:01:33") or integer Unix epoch
                        timestamp in milliseconds (e.g. --mod-
                        before=1642196636000) after which the app modified.
                        You can also specify negative numbers to indicate a
                        time period in the past suffixed by s, m, h, d, w, M
                        or y to indicate seconds, minutes, hours, days, weeks,
                        months or years (e.g. --mod-before=-2d for apps
                        modified earlier than 2 days ago)

`find globalworkflows`

`find jobs`

usage: dx find jobs [-h] [--id ID] [--name NAME] [--user USER]
                    [--project PROJECT] [--all-projects] [--app EXECUTABLE]
                    [--state STATE] [--origin ORIGIN] [--parent PARENT]
                    [--created-after CREATED_AFTER]
                    [--created-before CREATED_BEFORE] [--no-subjobs]
                    [--root-execution ROOT_EXECUTION] [-n N] [-o]
                    [--include-restarted] [--brief | --verbose] [--json]
                    [--color {off,on,auto}] [--delimiter [DELIMITER]]
                    [--env-help] [--property KEY[=VALUE]] [--tag TAG]
                    [--trees | --origin-jobs | --all-jobs]

Finds jobs subject to the given search parameters. By default, output is
formatted to show the last several job trees that you've run in the current
project.

options:
  -h, --help            show this help message and exit
  --id ID               Show only the job tree or job containing this job ID
  --name NAME           Restrict the search by job name (accepts wildcards "*"
                        and "?")
  --user USER           Username who launched the job (use "self" to ask for
                        your own jobs)
  --project PROJECT     Project context (output project), default is current
                        project if set
  --all-projects, --allprojects
                        Extend search to all projects
  --app, --applet, --executable EXECUTABLE
                        Applet or App ID that job is running
  --state STATE         State of the job, e.g. "done", "failed"
  --origin ORIGIN       Job ID of the top-level job
  --parent PARENT       Job ID of the parent job; implies --all-jobs
  --created-after CREATED_AFTER
                        Date (e.g. --created-after="2021-12-01" or
                        --created-after="2021-12-01 19:01:33") or integer Unix
                        epoch timestamp in milliseconds (e.g.
                        --created-after=1642196636000) after which the job was
                        last created. You can also specify negative numbers to
                        indicate a time period in the past suffixed by s, m,
                        h, d, w, M or y to indicate seconds, minutes, hours,
                        days, weeks, months or years (e.g. --created-after=-2d
                        for executions created in the last 2 days)
  --created-before CREATED_BEFORE
                        Date (e.g. --created-before="2021-12-01" or
                        --created-before="2021-12-01 19:01:33") or integer
                        Unix epoch timestamp in milliseconds (e.g.
                        --created-before=1642196636000) before which the job
                        was last created. You can also specify negative
                        numbers to indicate a time period in the past suffixed
                        by s, m, h, d, w, M or y to indicate seconds, minutes,
                        hours, days, weeks, months or years (e.g.
                        --created-before=-2d for executions created earlier
                        than 2 days ago)
  --no-subjobs          Do not show any subjobs
  --root-execution, --root ROOT_EXECUTION
                        Execution ID of the top-level (user-initiated) job or
                        analysis
  -n, --num-results N   Max number of results (trees or jobs, as according to
                        the search mode) to return (default 10)
  -o, --show-outputs    Show job outputs in results
  --include-restarted   if specified, results will include restarted jobs and
                        job trees rooted in restarted jobs
  --brief               Display a brief version of the return value; for most
                        commands, prints a DNAnexus ID per line
  --verbose             If available, displays extra verbose output
  --json                Display return value in JSON
  --color {off,on,auto}
                        Set when color is used (color=auto is used when stdout
                        is a TTY)
  --delimiter, --delim [DELIMITER]
                        Always use exactly one of DELIMITER to separate fields
                        to be printed; if no delimiter is provided with this
                        flag, TAB will be used
  --env-help            Display help message for overriding environment
                        variables
  --property KEY[=VALUE]
                        Key-value pair of a property or simply a property key;
                        if only a key is provided, matches a result that has
                        the key with any value; repeat as necessary, e.g.
                        "--property key1=val1 --property key2"
  --tag TAG             Tag to match; repeat as necessary, e.g. "--tag tag1
                        --tag tag2" will require both tags

Search mode:
  --trees               Show entire job trees for all matching results
                        (default)
  --origin-jobs         Search and display only top-level origin jobs
  --all-jobs            Search for jobs at all depths matching the query (no
                        tree structure shown)

`find analyses`

usage: dx find analyses [-h] [--id ID] [--name NAME] [--user USER]
                        [--project PROJECT] [--all-projects]
                        [--app EXECUTABLE] [--state STATE] [--origin ORIGIN]
                        [--parent PARENT] [--created-after CREATED_AFTER]
                        [--created-before CREATED_BEFORE] [--no-subjobs]
                        [--root-execution ROOT_EXECUTION] [-n N] [-o]
                        [--include-restarted] [--brief | --verbose] [--json]
                        [--color {off,on,auto}] [--delimiter [DELIMITER]]
                        [--env-help] [--property KEY[=VALUE]] [--tag TAG]
                        [--trees | --origin-jobs | --all-jobs]

Finds analyses subject to the given search parameters. By default, output is
formatted to show the last several job trees that you've run in the current
project.

options:
  -h, --help            show this help message and exit
  --id ID               Show only the job tree or job containing this job ID
  --name NAME           Restrict the search by job name (accepts wildcards "*"
                        and "?")
  --user USER           Username who launched the job (use "self" to ask for
                        your own jobs)
  --project PROJECT     Project context (output project), default is current
                        project if set
  --all-projects, --allprojects
                        Extend search to all projects
  --app, --applet, --executable EXECUTABLE
                        Applet or App ID that job is running
  --state STATE         State of the job, e.g. "done", "failed"
  --origin ORIGIN       Job ID of the top-level job
  --parent PARENT       Job ID of the parent job; implies --all-jobs
  --created-after CREATED_AFTER
                        Date (e.g. --created-after="2021-12-01" or
                        --created-after="2021-12-01 19:01:33") or integer Unix
                        epoch timestamp in milliseconds (e.g.
                        --created-after=1642196636000) after which the job was
                        last created. You can also specify negative numbers to
                        indicate a time period in the past suffixed by s, m,
                        h, d, w, M or y to indicate seconds, minutes, hours,
                        days, weeks, months or years (e.g. --created-after=-2d
                        for executions created in the last 2 days)
  --created-before CREATED_BEFORE
                        Date (e.g. --created-before="2021-12-01" or
                        --created-before="2021-12-01 19:01:33") or integer
                        Unix epoch timestamp in milliseconds (e.g.
                        --created-before=1642196636000) before which the job
                        was last created. You can also specify negative
                        numbers to indicate a time period in the past suffixed
                        by s, m, h, d, w, M or y to indicate seconds, minutes,
                        hours, days, weeks, months or years (e.g.
                        --created-before=-2d for executions created earlier
                        than 2 days ago)
  --no-subjobs          Do not show any subjobs
  --root-execution, --root ROOT_EXECUTION
                        Execution ID of the top-level (user-initiated) job or
                        analysis
  -n, --num-results N   Max number of results (trees or jobs, as according to
                        the search mode) to return (default 10)
  -o, --show-outputs    Show job outputs in results
  --include-restarted   if specified, results will include restarted jobs and
                        job trees rooted in restarted jobs
  --brief               Display a brief version of the return value; for most
                        commands, prints a DNAnexus ID per line
  --verbose             If available, displays extra verbose output
  --json                Display return value in JSON
  --color {off,on,auto}
                        Set when color is used (color=auto is used when stdout
                        is a TTY)
  --delimiter, --delim [DELIMITER]
                        Always use exactly one of DELIMITER to separate fields
                        to be printed; if no delimiter is provided with this
                        flag, TAB will be used
  --env-help            Display help message for overriding environment
                        variables
  --property KEY[=VALUE]
                        Key-value pair of a property or simply a property key;
                        if only a key is provided, matches a result that has
                        the key with any value; repeat as necessary, e.g.
                        "--property key1=val1 --property key2"
  --tag TAG             Tag to match; repeat as necessary, e.g. "--tag tag1
                        --tag tag2" will require both tags

Search mode:
  --trees               Show entire job trees for all matching results
                        (default)
  --origin-jobs         Search and display only top-level origin jobs
  --all-jobs            Search for jobs at all depths matching the query (no
                        tree structure shown)

`find executions`

Batch operations

`generate_batch_inputs`

usage: dx generate_batch_inputs [-h] [-i INPUT] [--path PROJECT:FOLDER]
                                [-o OUTPUT_PREFIX]

Generate a table of input files matching desired regular expressions for each
input.

options:
  -h, --help            show this help message and exit
  -i, --input INPUT     An input to be batch-processed "-i<input name>=<input
                        pattern>" where <input_pattern> is a regular
                        expression with a group corresponding to the desired
                        region to match (e.g. "-iinputa=SRR(.*)_1.gz"
                        "-iinputb=SRR(.*)_2.gz")
  --path PROJECT:FOLDER
                        Project and/or folder to which the search for input
                        files will be restricted
  -o, --output_prefix OUTPUT_PREFIX
                        Prefix for output file

Manage organizations

Category: org in dx help

Organization setup

`new org`

`new user`

Manage members

`add member`

usage: dx add member [-h] [--brief | --verbose] [--env-help]
                     --level {ADMIN,MEMBER} [--allow-billable-activities]
                     [--no-app-access]
                     [--project-access {ADMINISTER,CONTRIBUTE,UPLOAD,VIEW,NONE}]
                     [--no-email]
                     org_id username_or_user_id

Grant a user membership to an org

positional arguments:
  org_id                ID of the org
  username_or_user_id   Username or ID of user

options:
  -h, --help            show this help message and exit
  --brief               Display a brief version of the return value; for most
                        commands, prints a DNAnexus ID per line
  --verbose             If available, displays extra verbose output
  --env-help            Display help message for overriding environment
                        variables
  --level {ADMIN,MEMBER}
                        Org membership level that will be granted to the
                        specified user
  --allow-billable-activities
                        Grant the specified user "allowBillableActivities" in
                        the org
  --no-app-access       Disable "appAccess" for the specified user in the org
  --project-access {ADMINISTER,CONTRIBUTE,UPLOAD,VIEW,NONE}
                        The default implicit maximum permission the specified
                        user will receive to projects explicitly shared with
                        the org; default CONTRIBUTE
  --no-email            Disable org invitation email notification to the
                        specified user

`remove member`

usage: dx remove member [-h] [--brief | --verbose] [--env-help]
                        [--keep-explicit-project-permissions]
                        [--keep-explicit-app-permissions] [-y]
                        org_id username_or_user_id

Revoke the org membership of a user

positional arguments:
  org_id                ID of the org
  username_or_user_id   Username or ID of user

options:
  -h, --help            show this help message and exit
  --brief               Display a brief version of the return value; for most
                        commands, prints a DNAnexus ID per line
  --verbose             If available, displays extra verbose output
  --env-help            Display help message for overriding environment
                        variables
  --keep-explicit-project-permissions
                        Disable revocation of explicit project permissions of
                        the specified user to projects billed to the org;
                        implicit project permissions (i.e. those granted to
                        the specified user via his membership in this org)
                        will always be revoked
  --keep-explicit-app-permissions
                        Disable revocation of explicit app developer and user
                        permissions of the specified user to apps billed to
                        the org; implicit app permissions (i.e. those granted
                        to the specified user via his membership in this org)
                        will always be revoked
  -y, --yes             Do not ask for confirmation

`update`

usage: dx update [-h] target ...

Use this command with one of the available targets listed below to update
their metadata that are not covered by the other subcommands.

positional arguments:
  target
    org       Update information about an org
    workflow  Update the metadata for a workflow
    stage     Update the metadata for a stage in a workflow
    member    Update the membership of a user in an org
    project   Updates a specified project with the specified options

options:
  -h, --help  show this help message and exit

`update org`

`update member`

usage: dx update member [-h] [--brief | --verbose] [--env-help]
                        [--level {ADMIN,MEMBER}]
                        [--allow-billable-activities {true,false}]
                        [--app-access {true,false}]
                        [--project-access {ADMINISTER,CONTRIBUTE,UPLOAD,VIEW,NONE}]
                        org_id username_or_user_id

Update the membership of a user in an org

positional arguments:
  org_id                ID of the org
  username_or_user_id   Username or ID of user

options:
  -h, --help            show this help message and exit
  --brief               Display a brief version of the return value; for most
                        commands, prints a DNAnexus ID per line
  --verbose             If available, displays extra verbose output
  --env-help            Display help message for overriding environment
                        variables
  --level {ADMIN,MEMBER}
                        The new org membership level of the specified user
  --allow-billable-activities {true,false}
                        The new "allowBillableActivities" membership
                        permission of the specified user in the org; default
                        false if demoting the specified user from ADMIN to
                        MEMBER
  --app-access {true,false}
                        The new "appAccess" membership permission of the
                        specified user in the org; default true if demoting
                        the specified user from ADMIN to MEMBER
  --project-access {ADMINISTER,CONTRIBUTE,UPLOAD,VIEW,NONE}
                        The new default implicit maximum permission the
                        specified user will receive to projects explicitly
                        shared with the org; default CONTRIBUTE if demoting
                        the specified user from ADMIN to MEMBER

Searching

`find org`

usage: dx find org [-h] entities ...

List entities within a specific org.

positional arguments:
  entities
    members   List members in the specified org
    projects  List projects billed to the specified org
    apps      List apps billed to the specified org

options:
  -h, --help  show this help message and exit

`find orgs`

`find org members`

usage: dx find org members [-h] [--brief | --verbose] [--json]
                           [--delimiter [DELIMITER]] [--env-help]
                           [--level {ADMIN,MEMBER}]
                           org_id

Finds members in the specified org subject to the given search parameters

positional arguments:
  org_id                Org ID

options:
  -h, --help            show this help message and exit
  --brief               Display a brief version of the return value; for most
                        commands, prints a DNAnexus ID per line
  --verbose             If available, displays extra verbose output
  --json                Display return value in JSON
  --delimiter, --delim [DELIMITER]
                        Always use exactly one of DELIMITER to separate fields
                        to be printed; if no delimiter is provided with this
                        flag, TAB will be used
  --env-help            Display help message for overriding environment
                        variables
  --level {ADMIN,MEMBER}
                        Restrict the result set to contain only members at the
                        specified membership level.

`find org projects`

`find org apps`

`invite`

`uninvite`

Additional tools

Category: other in dx help

Advanced utilities for API access and asset management.

`api`

usage: dx api [-h] [--env-help] [--input INPUT] resource method [input_json]

Call an API method directly.  The JSON response from the API server will be
returned if successful.  No name resolution is performed; DNAnexus IDs must
always be provided.  The API specification can be found at

https://documentation.dnanexus.com/developer/api

EXAMPLE

  In the following example, a project's description is changed.

  $ dx api project-B0VK6F6gpqG6z7JGkbqQ000Q update '{"description": "desc"}'
  {
      "id": "project-B0VK6F6gpqG6z7JGkbqQ000Q"
  }

positional arguments:
  resource       One of "system", a class name (e.g. "record"), or an entity
                 ID such as "record-xxxx".  Use "app-name/1.0.0" to refer to
                 version "1.0.0" of the app named "name".
  method         Method name for the resource as documented by the API
                 specification
  input_json     JSON input for the method (if not given, "{}" is used)

options:
  -h, --help     show this help message and exit
  --env-help     Display help message for overriding environment
                 variables
  --input INPUT  Load JSON input from FILENAME ("-" to use stdin)

`build_asset`

usage: dx build_asset [-h] [-d DESTINATION] [--json] [--no-watch] [src_dir]

Build an asset from a local source directory. The directory must have a file
called "dxasset.json" containing valid JSON. For more details, see   https://d
ocumentation.dnanexus.com/developer/apps/dependency-management/asset-build-pro
cess

positional arguments:
  src_dir               Asset source directory (default: current directory)

options:
  -h, --help            show this help message and exit
  -d, --destination DESTINATION
                        Specifies the destination project and destination folder for the asset, in the
                        form [PROJECT_NAME_OR_ID:][/[FOLDER/][NAME]]
  --json                Show ID of resulting asset bundle in JSON format
  --no-watch            Don't watch the real-time logs of the asset-builder job.

`upgrade`

dx upgrade was removed in v0.379.0. See upgrading dxpy for guidance on installing and upgrading dxpy using pip3.

General purpose `dx` utilities

`dx-app-wizard`

usage: dx-app-wizard [-h] [--json-file JSON_FILE] [--language LANGUAGE]
                     [--template {basic,parallelized,scatter-process-gather}]
                     [name]

Create a source code directory for a DNAnexus app. You will be prompted for
various metadata for the app as well as for its input and output
specifications.

positional arguments:
  name                  Name of your app

options:
  -h, --help            show this help message and exit
  --json-file JSON_FILE
                        Use the metadata and IO spec found in the given file
  --language LANGUAGE   Programming language of your app
  --template {basic,parallelized,scatter-process-gather}
                        Execution pattern of your app

`dx-fetch-bundled-depends`

usage: dx-fetch-bundled-depends [-h]

Downloads the contents of runSpec.bundledDepends of a job running in the
execution environment.

options:
  -h, --help  show this help message and exit

`dx-generate-dxapp`

usage: dx-generate-dxapp [-h] [-m TARGET_MODULE] [-f TARGET_FUNCTION]
                         [-x TARGET_EXECUTABLE] [-s SUBCOMMAND]
                         [-o OUTPUT_FILE]
                         [-p OUTPUT_PARAMS [OUTPUT_PARAMS ...]]
                         [-r OUTPUT_PARAM_REGEXP] [-n {bash,python3}]
                         [-i INSTANCE_TYPE] [-t TIMEOUT]
                         [--distribution DISTRIBUTION] [--release RELEASE]
                         [--runspec-version RUNSPEC_VERSION]

options:
  -h, --help            show this help message and exit
  -m, --target-module TARGET_MODULE
                        The fully-qualified module that contains the target
                        method.
  -f, --target-function TARGET_FUNCTION
                        The main function that is called by the target
                        executable. This should bewhere the ArgumentParser is
                        configured.
  -x, --target-executable TARGET_EXECUTABLE
                        The name of the executable. This is used in the
                        dxapp.json runSpec.
  -s, --subcommand SUBCOMMAND
                        Subcommand to pass to the target method, if required.
  -o, --output-file OUTPUT_FILE
                        The output dxapp.json file. If not specified, output
                        will go to stdout.
  -p, --output-params OUTPUT_PARAMS [OUTPUT_PARAMS ...]
                        Names of output parameters (in case they can't be
                        autodetected).
  -r, --output-param-regexp OUTPUT_PARAM_REGEXP
                        Regular expression that identifies output parameter
                        names.
  -n, --interpreter {bash,python3}
                        Type of script that will wrap the executable.
  -i, --instance-type INSTANCE_TYPE
                        AWS instance type to use.
  -t, --timeout TIMEOUT
                        Max runtime of this app (in hours).
  --distribution DISTRIBUTION
                        Distribution to use for the machine image.
  --release RELEASE     Distribution release to use for the machine image.
  --runspec-version RUNSPEC_VERSION
                        Version of the application execution environment
                        inside the runSpec block.

`dx-jobutil-add-output`

usage: dx-jobutil-add-output [-h] [--class [CLASSNAME]] [--array] name value

Reads and modifies job_output.json in your home directory to be a JSON hash
with key *name* and value  *value*.

If --class is not provided or is set to "auto", auto-detection of the output
format will occur.  In particular, it will treat it as a number, hash, or
boolean if it can be successfully parsed as such.  If it is a string which
matches the pattern for a data object ID, it will encapsulate it in a DNAnexus
link hash; otherwise it is treated as a simple string.

Use --array to append to an array of values or prepend "array:" to the --class
argument.

To use the output of another job as part of your output, use --class=jobref
(which will throw an error if it is not formatted correctly), or use the
automatic parsing which will recognize anything starting with a job ID as a
job-based object reference.  You should format the value as follows:

  Format: <job ID>:<output field name>
  Example: dx-jobutil-add-output myoutput --class=jobref \
             job-B2JKYqK4Zg2K915yQxPQ0024:other_output

Analysis references can be specified similarly with --class=analysisref and
formatted as:

  Format: <analysis ID>:<stage ID>.<output field name>
          <analysis ID>:<exported output field name>
  Example: dx-jobutil-add-output myoutput --class=analysisref \
             analysis-B2JKYqK4Zg2K915yQxPQ0024:some_output

positional arguments:
  name                 Name of the output field name
  value                Value of the output field

options:
  -h, --help           show this help message and exit
  --class [CLASSNAME]  Class of output for formatting purposes, e.g. "int";
                       default "auto"
  --array              Output field is an array

`dx-jobutil-dxlink`

usage: dx-jobutil-dxlink [-h] object

Creates a DNAnexus link from an object ID or "<project ID>:<object ID>"
string. The result is of the form {"$dnanexus_link": "<object ID>"} or
{"$dnanexus_link": {"project": <project ID>, "id": <object ID>}}, as
appropriate.

positional arguments:
  object      Data object ID or "<Project ID>:<Data object ID>" to package
              into a DNAnexus link

options:
  -h, --help  show this help message and exit

`dx-jobutil-new-job`

usage: dx-jobutil-new-job [-h] [-i INPUT] [-j INPUT_JSON] [-f FILENAME]
                          [--instance-type INSTANCE_TYPE_OR_MAPPING]
                          [--instance-type-by-executable DOUBLE_MAPPING]
                          [--instance-type-help] [--extra-args EXTRA_ARGS]
                          [--property KEY=VALUE] [--tag TAG] [--name NAME]
                          [--depends-on [JOB_OR_OBJECT_ID ...]]
                          [--head-job-on-demand]
                          function

Creates a new job to run the named function with the specified input. If
successful, prints the ID of the new job.

positional arguments:
  function              Name of the function to run

options:
  -h, --help            show this help message and exit
  -i, --input INPUT     An input to be added using "<input
                        name>[:<class>]=<input value>" (provide "class" if
                        there is no input spec; it can be any job IO class,
                        e.g. "string", "array:string", or "array"; if "class"
                        is "array" or not specified, the value will be
                        attempted to be parsed as JSON and is otherwise
                        treated as a string)
  -j, --input-json INPUT_JSON
                        The full input JSON (keys=input field names,
                        values=input field values)
  -f, --input-json-file FILENAME
                        Load input JSON from FILENAME ("-" to use stdin)
  --instance-type INSTANCE_TYPE_OR_MAPPING
                        When running an app or applet, the mapping lists
                        executable's entry points or "*" as keys, and instance
                        types to use for these entry points as values. When
                        running a workflow, the specified instance types can
                        be prefixed by a stage name or stage index followed by
                        "=" to apply to a specific stage, or apply to all
                        workflow stages without such prefix. The instance type
                        corresponding to the "*" key is applied to all entry
                        points not explicitly mentioned in the --instance-type
                        mapping. Specifying a single instance type is
                        equivalent to using it for all entry points, so "--
                        instance-type mem1_ssd1_v2_x2" is same as "--instance-
                        type '{"*":"mem1_ssd1_v2_x2"}'. Note that "dx run"
                        calls within the execution subtree may override the
                        values specified at the root of the execution tree.
                        See dx run --instance-type-help for details.
  --instance-type-by-executable DOUBLE_MAPPING
                        Specifies instance types by app or applet id, then by
                        entry point within the executable. The order of
                        priority for this specification is: * --instance-type,
                        systemRequirements and stageSystemRequirements
                        specified at runtime * stage's systemRequirements,
                        systemRequirements supplied to /app/new and
                        /applet/new at workflow/app/applet build time *
                        systemRequirementsByExecutable specified in downstream
                        executions (if any) See dx run --instance-type-help
                        for details.
  --instance-type-help  Print help for specifying instance types
  --extra-args EXTRA_ARGS
                        Arguments (in JSON format) to pass to the underlying
                        API method, overriding the default settings
  --property KEY=VALUE  Key-value pair to add as a property; repeat as
                        necessary, e.g. "--property key1=val1 --property
                        key2=val2"
  --tag TAG             Tag for the resulting execution; repeat as necessary,
                        e.g. "--tag tag1 --tag tag2"
  --name NAME           Name for the new job (default is the current job name,
                        plus ":<function>")
  --depends-on [JOB_OR_OBJECT_ID ...]
                        Job and/or data object IDs that must finish or close
                        before the new job should be run. WARNING: For proper
                        parsing, do not use this flag directly before the
                        *function* parameter.
  --head-job-on-demand  Whether the head job should be run on an on-demand
                        instance

`dx-jobutil-parse-link`

usage: dx-jobutil-parse-link [-h] [--no-project] dxlink

Parse a dxlink JSON hash into an object ID or project:object-id tuple

positional arguments:
  dxlink        Link to parse

options:
  -h, --help    show this help message and exit
  --no-project  Ignore project ID in an extended dxlink - just print the
                object ID

`dx-jobutil-report-error`

usage: dx-jobutil-report-error [-h] message [{AppInternalError,AppError}]

Creates job_error.json in your home directory, a JSON file to include the
error type and message for the running job. There are two types of errors you
may report: 1) AppError (the default) for recognized actionable errors, and 2)
AppInternalError for unexpected application errors.

positional arguments:
  message               Error message for the job
  {AppInternalError,AppError}
                        Error type

options:
  -h, --help            show this help message and exit

`dx-jobutil-get-identity-token`

usage: dx-jobutil-get-identity-token [-h] --aud AUD
                                     [--subject_claims <subject_claims>]

calls job-xxxx/getIdentityToken and retrieves a JWT token based on aud and
subject claims input

options:
  -h, --help            show this help message and exit
  --aud AUD             Audience URI the JWT is intended for
  --subject_claims <subject_claims>
                        Defines the subject claims to be validated by the
                        cloud provider

`dx-log-stream`

usage: dx-log-stream [-h] [-l {critical,error,warning,info,debug}]
                     [-s {DX_APP,DX_APP_STREAM}]

Redirects stdin to a DNAnexus log socket in the execution environment.

Valid logging levels:

┌─────────────────────────┬────────────────┬────────────┐
│ --source                │ --level        │ Appears as │
├─────────────────────────┼────────────────┼────────────┤
│ DX_APP_STREAM (default) │ info (default) │ STDOUT     │
│ DX_APP_STREAM (default) │ error          │ STDERR     │
├─────────────────────────┼────────────────┼────────────┤
│ DX_APP                  │ debug          │ DEBUG      │
│ DX_APP                  │ info (default) │ INFO       │
│ DX_APP                  │ warning        │ WARNING    │
│ DX_APP                  │ error          │ ERROR      │
│ DX_APP                  │ critical       │ CRITICAL   │
└─────────────────────────┴────────────────┴────────────┘

options:
  -h, --help            show this help message and exit
  -l, --level {critical,error,warning,info,debug}
                        Logging level to use
  -s, --source {DX_APP,DX_APP_STREAM}
                        Source ID to use

`dx-mount-all-inputs`

usage: dx-mount-all-inputs [-h] [--except EXCLUDE] [--verbose]

Note: this is a utility for use by bash apps running in the DNAnexus Platform.

Mounts all files that were supplied as inputs to the app.  By convention, if
an input parameter "FOO" has value

    {"$dnanexus_link": "file-xxxx"}

and filename INPUT.TXT, then the linked file will be mounted into the path:

    $HOME/in/FOO/INPUT.TXT

If an input is an array of files, then all files will be placed into numbered
subdirectories under a parent directory named for the input. For example, if
the input key is FOO, and the inputs are {A, B, C}.vcf then, the directory
structure will be:

    $HOME/in/FOO/0/A.vcf
                 1/B.vcf
                 2/C.vcf

Zero padding is used to ensure argument order. For example, if there are 12
input files {A, B, C, D, E, F, G, H, I, J, K, L}.txt, the directory structure
will be:

    $HOME/in/FOO/00/A.vcf
                 ...
                 11/L.vcf

This allows using shell globbing (FOO/*/*.vcf) to get all the files in the
input order.

options:
  -h, --help        show this help message and exit
  --except EXCLUDE  Do not mount the input with this name. (May be used
                    multiple times.)
  --verbose         Start dxfuse with '-verbose 2' logging

`dx-notebook-reconnect`

usage: dx-notebook-reconnect [-h] [--port PORT] job_id

Reconnect to a notebook job

positional arguments:
  job_id       Job-id of the notebook job to reconnect to.

options:
  -h, --help   show this help message and exit
  --port PORT  Local port to use for connecting.

`dx-print-bash-vars`

usage: dx-print-bash-vars [-h]

Parses $HOME/job_input.json and prints the bash variables that would be
available in the execution environment.

options:
  -h, --help  show this help message and exit

Utilities useful in writing bash apps and applets

`dx-download-all-inputs`

usage: dx-download-all-inputs [-h] [--except EXCLUDE] [--parallel]
                              [--sequential]

Note: this is a utility for use by bash apps running in the DNAnexus Platform.

Downloads all files that were supplied as inputs to the app.  By convention,
if an input parameter "FOO" has value

    {"$dnanexus_link": "file-xxxx"}

and filename INPUT.TXT, then the linked file will be downloaded into the path:

    $HOME/in/FOO/INPUT.TXT

If an input is an array of files, then all files will be placed into numbered
subdirectories under a parent directory named for the input. For example, if
the input key is FOO, and the inputs are {A, B, C}.vcf then, the directory
structure will be:

    $HOME/in/FOO/0/A.vcf
                 1/B.vcf
                 2/C.vcf

Zero padding is used to ensure argument order. For example, if there are 12
input files {A, B, C, D, E, F, G, H, I, J, K, L}.txt, the directory structure
will be:

    $HOME/in/FOO/00/A.vcf
                 ...
                 11/L.vcf

This allows using shell globbing (FOO/*/*.vcf) to get all the files in the
input order.

options:
  -h, --help        show this help message and exit
  --except EXCLUDE  Do not download the input with this name. (May be used
                    multiple times.)
  --parallel        Download the files in parallel
  --sequential      Download the files sequentially

`dx-upload-all-outputs`

usage: dx-upload-all-outputs [-h] [--except EXCLUDE] [--parallel]
                             [--sequential] [--clearJSON CLEARJSON]
                             [--wait-on-close] [--xattr-properties]

Note: this is a utility for use by bash apps running in the DNAnexus Platform.

Uploads all files and subdirectories in the directory $HOME/out, as described
below. It also adds relevant entries into the job_output.json file.

By convention, only directories with names equal to output parameter names are
expected to be found in the output directory, and any file(s) found in those
subdirectories will be uploaded as the corresponding outputs.  For example, a
file with the path

    $HOME/out/FOO/OUTPUT.TXT

will be uploaded, and the key "FOO" will be added to the job_output.json file
with value

    {"$dnanexus_link": "file-xxxx"}

where "file-xxxx" is the ID of the newly uploaded file. If multiple files are
found, they will be added as an array output (in unspecified order). If
subdirectories are found under $HOME/out/FOO, then they are uploaded in their
entirety to the workspace, and values are added to FOO in the job_output.json
file. For example, the path:

    $HOME/out/FOO/BAR/XXX.TXT

will be uploaded to /BAR/XXX.TXT.

options:
  -h, --help            show this help message and exit
  --except EXCLUDE      Do not upload the input with this name. (May be used
                        multiple times.)
  --parallel            Upload the files in parallel
  --sequential          Upload the files sequentially
  --clearJSON CLEARJSON
                        Clears the output JSON file prior to starting upload.
  --wait-on-close       Wait for files to close, default is not to wait
  --xattr-properties    Get filesystem attributes and set them as properties on each file uploaded

Last updated 17 days ago

Was this helpful?