DAP CLI

dap is the command-line client for the Dovetail Analysis Portal (DAP): log in, list and submit runs, and upload/download files without leaving a terminal. It talks to the DAP server over plain HTTP and is a standalone package, separate from the DAP web app itself.

Install

$ pip install dovecli

This installs the dap command on your PATH, along with its only two runtime dependencies, click and requests. Requires Python 3.9+.

Quickstart

$ dap login
Email: you@example.com
Password:
Logged in.

$ dap whoami
you@example.com -- 5 credits

$ dap files list
$ dap files upload /path/to/reads_R1.fastq.gz

$ dap runs cancer-types
$ dap submit sv --name my-first-run \
    --tumor s3://bucket/user_1/tumor_R1.fastq.gz s3://bucket/user_1/tumor_R2.fastq.gz \
    --cancer-type Breast

$ dap runs list
$ dap runs status <run-id> --watch

By default dap talks to https://portal.cantatabio.com. Point it at a different server with dap login --api-url ... or the DAP_API_URL environment variable. Your login token is stored locally at ~/.dap/config.json (override with DAP_CONFIG_DIR); your password is never saved.