Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 1.04 KB

Cli.md

File metadata and controls

31 lines (24 loc) · 1.04 KB

Command line interface

MIP uses MooseX::App to create a single command line interface (CLI) entry point to all MIP related processes. The main application is called by:

$ mip

This will show the usage, global parameters and all available commands and subcommands. There is currently three main commands:

  • Installation
    • rd_dna
    • rd_rna
  • Analyse
    • rd_dna
    • rd_rna
    • rd_dna_vcf_rerun
  • Download
    • rd_dna
    • rd_rna

There are three levels of parameters:

  • Global
  • Commands
  • Subcommands

These parameters are defined for the CLI at each level of the underlying namespace in lib/MIP/Cli. The complete parameter feature is defined for each command and subcommand in definition file located under definitions.

A parameter that is unique to a command or subcommand should only be defined once in that namespace and corresponding definitions file.

A parameter that is shared by all subsequent processes only needs to be defined in the parent namespace and corresponding definitions file.