Pre-release

This release is a pre-release and may not be stable for production use.

Adagio CLI

adagio-cli is the Python command-line interface for Adagio pipeline execution.

For user-facing documentation and product guides, please reference the docs:

The adagio frontend is used to build pipelines that can be run with this package on the command line It can be found here:

Development

Set up the project and run the test suite with:

uv sync --group dev
uv run pytest

Runtime environments

Every plugin action requires an explicit execution environment. A runtime config passed with --config can define one default and override it per plugin or task; the CLI never guesses an image from a plugin name.

Conda environments are supported with kind = "conda":

version = 1

[defaults]
kind = "conda"
prefix = "/opt/conda/envs/qiime2-2026.1"

[plugins]
dada2 = { kind = "conda", prefix = "/opt/conda/envs/q2-dada2" }

The environment must already exist and contain QIIME 2 plus the plugins needed by the pipeline. Adagio enters it with conda run; it does not create or manage the environment.

Plugin submission defaults

QAPI submissions can persist the environment that Adagio should use for the submitted plugins:

adagio qapi build --plugin my-plugin \
  --default-conda-prefix /opt/conda/envs/my-plugin

adagio qapi build --plugin my-plugin \
  --default-docker-image registry.example.org/my-plugin:2026.1

These options are explicit and mutually exclusive. Omitting both leaves the plugin without a default; the Adagio app will flag that plugin until an environment is selected for a run.

Catalog pipelines

Run a pipeline from the Adagio pipeline catalog:

adagio pipeline show @adagio/microbial-diversity
adagio run @adagio/microbial-diversity --cache-dir /path/to/cache --arguments run-arguments.json

@adagio/<slug> first resolves against a nearby local adagio-pipelines checkout when one is available. If no local catalog is found, Adagio fetches pipeline.adg from cymis/adagio-pipelines on GitHub, checking official before community.

During adagio run, remote catalog pipelines are downloaded under the selected --cache-dir and reused by source name and slug on later runs. adagio pipeline show uses a temporary download when it fetches from GitHub because it does not take a cache directory.

Private GitHub access is explicit: set GITHUB_TOKEN or GH_TOKEN to a token that can read cymis/adagio-pipelines; with a token, the CLI fetches through the GitHub contents API. The CLI does not read browser, git, or gh credentials automatically.

Project links

Data verified by PyPI on
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.1.0a9)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for johnac49 from gravatar.com johnac49

Credits

Author: Cymis

GitHub Statistics

Data verified by PyPI on 
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python >=3.10

Tags

adagio bioinformatics cli pipelines qiime2 workflow

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adagio_cli-0.1.0a8.tar.gz (69.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

adagio_cli-0.1.0a8-py3-none-any.whl (92.9 kB view details)

Uploaded Python 3

File details

Details for the file adagio_cli-0.1.0a8.tar.gz.

File metadata

  • Download URL: adagio_cli-0.1.0a8.tar.gz
  • Upload date:
  • Size: 69.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for adagio_cli-0.1.0a8.tar.gz
Algorithm Hash digest
SHA256 f953ec4e4d58c092b9aedb93d1d1f94b490f3a25f769fd2038c338691e1bb2c4
MD5 f4d39229d04da6788a3cc606bd1430bb
BLAKE2b-256 2e9a1afd9c37fd42c0da7378367c1242b33a43e990491b40e4cf76121bfa9c16

See more details on using hashes here.

Provenance

The following attestation bundles were made for adagio_cli-0.1.0a8.tar.gz:

Publisher: publish.yml on cymis/adagio-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file adagio_cli-0.1.0a8-py3-none-any.whl.

File metadata

  • Download URL: adagio_cli-0.1.0a8-py3-none-any.whl
  • Upload date:
  • Size: 92.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for adagio_cli-0.1.0a8-py3-none-any.whl
Algorithm Hash digest
SHA256 b6fe5073b1d4747457817630bc797a203fff5cd0eafa752266d1f88f565351ac
MD5 99870f99fbf453f2458e0367d5f7d31e
BLAKE2b-256 7a17bdf3529b969fcccaef89aebe2929b46bdd9432b1ebf08c330b298e90c4e4

See more details on using hashes here.

Provenance

The following attestation bundles were made for adagio_cli-0.1.0a8-py3-none-any.whl:

Publisher: publish.yml on cymis/adagio-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page