search
Illumina Connected SoftwareIllumina.comIllumina Support

How to list BaseSpace entities using BaseSpace CLI

One of the key features of the BaseSpace CLI tool is the ability to list the various entities, such as Runs, Projects and Biosamples accessible by the current BaseSpace account. This includes entities owned by as well as those shared with the current user. The list command is a quick way to get Ids and Names of entities, which can then be used as input into downstream BaseSpace CLI commands. In its simplest form the list command is structured as below:

bs list <entity>

Available BaseSpace entities: appresult, appsession, biosample, dataset, project, run, trash

The example below is a truncated output listing all Runs accessible under the current BaseSpace account. The default output is a table format that is easy for humans to read:

bs list run+------------------------------------------------------------------+-----------+-------------------------------------------------------------------+------------------+| Name | Id | ExperimentName | Status |+------------------------------------------------------------------+-----------+-------------------------------------------------------------------+------------------+| 150109\_NS500101\_0203\_ANextSeq\_500\_V2\_RNA-Seq\_(8plex)\_-\_H3GYJBGXX | 10149162 | NextSeq 500 V2: RNA-Seq (8plex) - H3GYJBGXX | Complete || 150123\_P3018\_0319\_ANextSeq\_500\_V2\_Nano350\_(PhiX)\_H3GNKBGXX | 10383420 | NextSeq 500 V2: Nano350 (PhiX)\_H3GNKBGXX | Complete || 160907\_NB500983\_0241\_AH2LWNBGXY | 20865846 | TruSight\_Tumor\_170\_Example\_Dataset | Complete || 170220\_A00103\_0014\_AHMWVDMCVY | 23564552 | NovaSeq: TruSeq Nano 550 (Replicates of NA12878) | Failed |...

Fields In the table output, above the column titles (headers) are the default "fields" printed with the simple list run command. These fields can be specified using the -F flag combination in the command to provide more or less information about each result, and tailor the output to the user's desires:

bs list run -F ExperimentName -F Id -F UserOwnedBy.Name+-------------------------------------------------------------------+-----------+-----------------------------------+| ExperimentName | Id | UserOwnedBy.Name |+-------------------------------------------------------------------+-----------+-----------------------------------+| NextSeq 500 V2: RNA-Seq (8plex) - H3GYJBGXX | 10149162 | Illumina Inc || NextSeq 500 V2: Nano350 (PhiX)\_H3GNKBGXX | 10383420 | Illumina Public Data || TruSight\_Tumor\_170\_Example\_Dataset | 20865846 | Illumina Public Data || NovaSeq: TruSeq Nano 550 (Replicates of NA12878) | 23564552 | Illumina Public Data |...

The various fields can be used to filter results to avoid needing to print and search through the entire list of entities. One can specify the CLI only return results where the field designated with the --filter-field flag contains the string designated with the --filter-term flag:

bs list run --filter-field ExperimentName --filter-term NovaSeq+----------------------------------------------------+-----------+----------------------------------------------------+----------+| Name | Id | ExperimentName | Status |+----------------------------------------------------+-----------+----------------------------------------------------+----------+| 170220\_A00103\_0014\_AHMWVDMCVY | 23564552 | NovaSeq: TruSeq Nano 550 (Replicates of NA12878) | Failed |+----------------------------------------------------+-----------+----------------------------------------------------+----------+

Filtering In the example above, the results are limited to only those runs where the case-sensitive string "NovaSeq" is found in the field ExperimentName. The string listed in filter-term can comprise all, or part, of the field listed in --filter-field. For example, simply using the string "Seq" will return more matches:

bs list run --filter-field ExperimentName --filter-term Seq+------------------------------------------------------------------+-----------+----------------------------------------------------+----------+| Name | Id | ExperimentName | Status |+------------------------------------------------------------------+-----------+----------------------------------------------------+----------+| 150109\_NS500101\_0203\_ANextSeq\_500\_V2\_RNA-Seq\_(8plex)\_-\_H3GYJBGXX | 10149162 | NextSeq 500 V2: RNA-Seq (8plex) - H3GYJBGXX | Complete || 150123\_P3018\_0319\_ANextSeq\_500\_V2\_Nano350\_(PhiX)\_H3GNKBGXX | 10383420 | NextSeq 500 V2: Nano350 (PhiX)\_H3GNKBGXX | Complete || 170220\_A00103\_0014\_AHMWVDMCVY | 23564552 | NovaSeq: TruSeq Nano 550 (Replicates of NA12878) | Failed || 180117\_SN901\_0713\_ACBTVAANXX | 59519461 | HiSeq 2500: TruSight Oncology UMI Reagents | Failed || 180718\_M04499\_0151\_000000000-BWFHW | 105217112 | Myeloid\_DNA\_Public\_Data\_MiSeq\_11pM | Complete |...

It is also possible to filter based on the --date-field of an entity using the --newer-than and --older-than flags. The default --date-field is the entity creation date (DateCreated). The example below lists all runs that were created in the past 5 weeks:

bs list run --newer-than 5w+------------------------------------+-----------+------------------------------------+----------+| Name | Id | ExperimentName | Status |+------------------------------------+-----------+------------------------------------+----------+| 180710\_NS500507\_0380\_AH3FWGBGX5 | 103242144 | PhiX-Run | Complete || 180718\_M04499\_0151\_000000000-BWFHW | 105217112 | Myeloid\_DNA\_Public\_Data\_MiSeq\_11pM | Complete |+------------------------------------+-----------+------------------------------------+----------+

Available time suffixes: s (seconds), m (minutes), h (hours), d (days), w (weeks), y (years)

Formatting There are other options for formatting outputs that may be more useful as input into downstream commands or programs, such as comma-separated value (CSV) lists:

bs list runs --filter-field ExperimentName --filter-term NovaSeq -f csvName,Id,ExperimentName,Status170220\_A00103\_0014\_AHMWVDMCVY,23564552,NovaSeq: TruSeq Nano 550 (Replicates of NA12878),Failed

Available output formats: yaml,json,xml,csv,table (default)

bs list runs -c bifx --filter-field ExperimentName --filter-term NovaSeq -f json [ { "HrefBaseSpaceUI": "https://basespace.illumina.com/run/23564552/NovaSeq-TruSeq-Nano-550-Replicates-of-NA12878", "Name": "170220\_A00103\_0014\_AHMWVDMCVY", "Id": "23564552",... }]

The option to output in JSON format is also available, and can provide much more information in a format easily accessible by many downstream programs. Above is the raw output and has been truncated, while below output.jsonarrow-up-right for the full output text:

For any feedback or questions regarding this article (Illumina Knowledge Article #3682), contact Illumina Technical Support [email protected]envelope.

Last updated

Was this helpful?