molgenis / molgenis-tools-commander

A command line interface for MOLGENIS
GNU Lesser General Public License v3.0
8 stars 8 forks source link

Document how you can run a script that is not stored in the scripts folder #215

Closed fdlk closed 3 years ago

fdlk commented 3 years ago

How to Reproduce

mcmd script -h

Expected behavior

I see how I can run a script using --from-path

Observed behavior

--from-path argument is not described in the help:

usage:  script [-h] [--create | --list | --delete SCRIPT NAME | --read SCRIPT NAME] [--number NUMBER] [--show-fails]

optional arguments:
  -h, --help            show this help message and exit
  --create              create a script from the history (this is the default action)
  --list, -l            list the stored scripts
  --delete SCRIPT NAME, -D SCRIPT NAME
                        remove a script
  --read SCRIPT NAME, -r SCRIPT NAME
                        read the contents of a script
  --number NUMBER, -n NUMBER
                        number of lines of history to choose from (default: 10)
  --show-fails, -f      also show the failed commands from history (disabled by default)
tommydeboer commented 3 years ago

@fdlk To run a script you need to use the run command. There the --from-path argument is explained!