dirscan icon indicating copy to clipboard operation
dirscan copied to clipboard

Help command is incomplete

Open nuc1eon opened this issue 5 years ago • 2 comments

Currently dirscan --help is very incomplete.

The official readme lists a lot more parameters that should be included.

nuc1eon avatar Apr 07 '20 20:04 nuc1eon

Hey! Can you give some examples? All parameters should be listed as they are generated automatically from structopt.

orf avatar Apr 12 '20 10:04 orf

Hey sure, so currently the help output looks like this:

dirscan 0.3.0
Summarize directories, fast.

USAGE:
    dirscan <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    help      Prints this message or the help of the given subcommand(s)
    parse     Parse results files
    scan      Scan a directory
    stream    Stream file paths to stdout from a given set of directories

Going by the official Readme, the following options and it's descriptions are missing:

  • --prefix
  • --depth
  • --output
  • --threads
  • --format
  • --sort

EDIT: Ohh I see, they show up when I type for example dirscan parse --help Is that usual behaviour?

nuc1eon avatar Apr 12 '20 19:04 nuc1eon