Skip to main content

SAURUS-CLI

Command-line access to the SAURUS Staphylococcus aureus genomic surveillance database.

DOI License: MIT

SAURUS-CLI lets you query 139,257 S. aureus genomes by MLST, spa, SCCmec, agr, capsule, AMR genes, virulence factors, and epidemiological metadataโ€”directly from your terminal. It is designed for reproducible surveillance and seamless integration into bioinformatics pipelines (Nextflow, Snakemake, Bash).


Installation

# 1. Clone the repository
git clone https://github.com/bbeckley-hub/saurus-cli.git
cd saurus-cli

# 2. Install in editable mode (recommended for development)
pip install -e .

After installation, the saurus command is available globally.


Quick Start

The most common workflow is: filter โ†’ export โ†’ download.

1. Filter by lineage

# Find all USA300 (ST8, t008, SCCmec IV, agr I) genomes
saurus --lineage USA300 --count

2. Combine genotype and geography

# USA300 bloodstream isolates from the United States
saurus --lineage USA300 --country USA --source blood --count

3. Export accessions

# Save the matching genome accessions to a text file
saurus --lineage USA300 --country USA --source blood -o usa300_blood.txt

4. Download genomes from NCBI

# Feed the accession list to NCBI datasets
datasets download genome accession --inputfile usa300_blood.txt --filename usa300_blood.zip

Core Usage

Query Flags

Flag Description Example
--st MLST Sequence Type --st 5 or --st ST5
--cc Clonal Complex --cc 398 or --cc CC398
--spa spa Type --spa t002
--sccmec SCCmec Type --sccmec II
--agr agr Type --agr I
--capsule Capsule Serotype --capsule 5 or --capsule 8
--mrsa Filter only MRSA --mrsa
--mssa Filter only MSSA --mssa
--country Country of origin (searches both country and country_raw) --country USA or --country "United States"
--source Isolation source (searches both source and source_raw) --source blood or --source nasal
--host Host species --host "Homo sapiens"
--year Collection year or range --year 2019 or --year 2015-2023
--amr AMR gene(s), comma-separated --amr mecA,tetM
--vfdb Virulence gene(s), comma-separated --vfdb pvl,tst
--plasmid Plasmid replicon(s), comma-separated --plasmid rep5a
--any Match ANY gene (default is ALL) --amr mecA,tetM --any

Output Options

Flag Description Default
--count Print only the number of matching genomes Off
--format Output format: accession, tsv, csv accession
--output, -o Output file path stdout
--debug Show row counts after each filter Off

Pre-defined Lineage Signatures

Use --lineage to apply a curated signature without typing every flag.

Lineage Signature
USA100 ST5, t002, SCCmec II, agr II, capsule 5
USA300 ST8, t008, SCCmec IV, agr I, capsule 5
USA400 ST1, t128, SCCmec IV, agr III, capsule 8
USA500 ST8, t064, SCCmec IV, agr I, capsule 5
EMRSA-15 ST22, t032, SCCmec IV, agr I, capsule 5
EMRSA-16 ST36, t018, SCCmec II, agr III, capsule 8
Bengal Bay ST772, t657, SCCmec V, agr II, capsule 5
ST152 ST152, SCCmec V, agr III, capsule 5

Note: Any flag you pass alongside --lineage overrides the signature. For example, --lineage USA300 --country Japan will use the USA300 signature but restrict results to Japan.


Reproducible Queries with Config Files

For recurring surveillance tasks, save your query as a JSON file.

usa100_surveillance.json

{
  "st": "5",
  "sccmec": "II",
  "agr": "II",
  "capsule": "5",
  "spa": "t002",
  "source": "blood",
  "country": "USA",
  "format": "tsv",
  "output": "usa100_blood.tsv"
}

Run it with:

saurus --config usa100_surveillance.json

Example 1: The "Classic" USA100 Query

saurus --st 5 --sccmec II --agr II --capsule 5 --spa t002 --source blood --country USA

Expected result: ~297 genomes (blood isolates in the USA).

Example 2: USA300 Bloodstream Infections (2005โ€“2015)

saurus --lineage USA300 --source blood --year 2005-2015 -o usa300_blood_2005_2015.txt

Example 3: Livestock-Associated MRSA (CC398) in Denmark

saurus --cc 398 --mrsa --country Denmark --host "Sus scrofa" --count

Example 4: PVL-Positive ST8 Genomes

saurus --st 8 --vfdb lukS-PV --count

Example 5: Multi-Drug Resistant Genomes (mecA + tetM + ermB)

saurus --amr mecA,tetM,ermB --any --count

Example 6: Pipeline Integration

# Pipe directly into NCBI datasets (no intermediate file)
saurus --lineage EMRSA-15 --country "United Kingdom" | \
  datasets download genome accession --inputfile /dev/stdin --filename emrsa15_uk.zip

Data Requirements

SAURUS-CLI expects a data/ directory with the following structure:

data/
โ”œโ”€โ”€ mrsa/
โ”‚   โ””โ”€โ”€ mrsa_all.tsv          # Master TSV (all typing + metadata)
โ”œโ”€โ”€ mlst/
โ”‚   โ”œโ”€โ”€ mlst_all.tsv
โ”‚   โ””โ”€โ”€ cc.txt
โ”œโ”€โ”€ spa/
โ”‚   โ””โ”€โ”€ spa_all.tsv
โ”œโ”€โ”€ sccmec/
โ”‚   โ”œโ”€โ”€ sccmec_cge_all.tsv
โ”‚   โ””โ”€โ”€ sccmec_rpet_all.tsv
โ”œโ”€โ”€ agr/
โ”‚   โ””โ”€โ”€ agr_all.tsv
โ”œโ”€โ”€ capsule/
โ”‚   โ””โ”€โ”€ capsule_all.tsv
โ”œโ”€โ”€ metadata/
โ”‚   โ””โ”€โ”€ metadata.tsv
โ””โ”€โ”€ gene_annotation/
    โ”œโ”€โ”€ amr_all.tsv
    โ”œโ”€โ”€ vfdb_all.tsv
    โ””โ”€โ”€ plasmid_all.tsv

To regenerate the master TSV from individual modules:

python scripts/build_master_tsv.py

Citation

If you use SAURUS-CLI in your research, please cite:

Beckley B, Amarh V. StaphScope: a species-optimized computational pipeline for rapid and accessible Staphylococcus aureus genotyping and surveillance. BMC Genomics. 2026;27:261. doi:10.1186/s12864-026-12609-x

And the underlying gene dataset:

Shelenkov A, Slavokhotova A, Yunusova M, et al. Genomic typing, antimicrobial resistance gene, virulence factor and plasmid replicon database for the important pathogenic bacteria Staphylococcus aureus. BMC Genom Data. 2025;26:65. doi:10.1186/s12863-025-01363-w


License

MIT License. See LICENSE for details.

Metadata

Release files for saurus-cli 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for saurus-cli 0.1.0
File Size Uploaded Provenance Actions
saurus_cli-0.1.0.tar.gz 13.3 MB Without provenance Details for saurus_cli-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for saurus-cli 0.1.0
File Interpreter ABI Platform Actions
saurus_cli-0.1.0-py3-none-any.whl Python 3 none any Details for saurus_cli-0.1.0-py3-none-any.whl

Total release size: 26.6 MB

Release files / saurus_cli-0.1.0.tar.gz

Download URL saurus_cli-0.1.0.tar.gz
Size 13.3 MB
Tags Source
SHA-256 checksum
How to use checksums
2e2562cf4c5dc371e0918c20bc04840b056143bb7a8d9299882b9e066b5c61e5
BLAKE2b-256 checksum
How to use checksums
bc689fb527429f93ef4771f3b2c6e4cafc1771645bb527085ef17c1f3cf8263c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release files / saurus_cli-0.1.0-py3-none-any.whl

Download URL saurus_cli-0.1.0-py3-none-any.whl
Size 13.3 MB
Tags Python 3
SHA-256 checksum
How to use checksums
fc6c42bff3a793e01b87d0583dc171a43f31901c20ba7eb35a22d7ad3b3f55ff
BLAKE2b-256 checksum
How to use checksums
6566264b7680364de9ef36beab160ab2eb23186d49cff7ffdd06c3f86c2ed8b4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Security for saurus-cli 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page