nextflow-io / nextflow-io/nextflow
Evolution of Nextflow command line interface
Open
@bentsherman is already working on this.
Since Feb 1, 2023.
- Dominant language
- Groovy
- Stars
- 3.5k
- Forks
- 811
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 61
Description
Nextflow CLI is quite flexible, however, there are some legacy problems hard to solve without re-engineering it.
Common problems are:
- the lack of support list values
- the mix of nextflow options pipeline parameters with
- the use of the non-standard convention of options prefix i.e.
-long-optioninstead of more --common--long-option - implicit type conversion can have nasty side-effects
- double-notation (ie.
--fooBarand--foo-bar) for pipeline params can create ambiguity and unexpected errors
The goal of this issue is to introduce a nextflow command line tool, named nf to address the above issue and keep backward compatibility with the existing command line whenever possible.
The following features should be supported
- use the GNU syntax conventions for command line options. Therefore
-is only used for single char options and the prefix--is used for options for two or more characters. - Support list of values when an option is repeated more than once
- Implicit conversion only for basic types i.e. integer numbers and boolean values (true/false)
- Separate nextflow options from pipeline options using
--separate e.g.nextflow run <pipeline> --resume -- --foo --bar - avoid double notation for pipeline parameters
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.