unrecognized arguments: --word-list

[reddybhaskarvengala]

Hi Team,

I am trying to use --word-list argument like below. but it is saying the argument is unkown

detect-secrets scan --word-list a/b/c/WORD_LIST_FILE --no-verify --all-files
usage: detect-secrets [-h] [-v] [--version] [-C <path>] [-c NUM_CORES]
                      {scan,audit} ...
detect-secrets: error: unrecognized arguments: --word-list

detect-secrets --version: 1.1.0

[lorenzodb1]

Closing as I cannot reproduce the issue on version 1.2.0

[mark-pictor-csec]

also seen with v1.2.0 installed from pip.
python 3.8, pip 22.0.4, osx

[lorenzodb1]

Hi @mark-pictor-csec! Thank you for reporting this. I was able to reproduce the issue and, therefore, I will reopen this issue and further investigate this issue.

[jpdakran]

@mark-pictor-csec Do you have pyahocorasick installed? To leverage this feature - this must be installed in the pip env.

[mark-pictor-csec]

I did not. That seems to fix it, as --word-list now appears in the help output - haven't actually tested yet.

[jpdakran]

Some documentation on the word-list feature: https://github.com/Yelp/detect-secrets#wordlist @mark-pictor-csec @BhaskiBuzz. Please reach out if there are any other problems.

[lorenzodb1]

Thank you @jpdakran for chiming in.

@BhaskiBuzz and @mark-pictor-csec being this feature well documented, I'll close this issue again. Feel free to re-open it or create a new issue if you have any additional concerns or suggestions.

[mark-pictor-csec]

I read over that and somehow missed the required dependency; I also looked at the code but didn't see what the problem was. I'm a little surprised I didn't see something in the code, but then again python isn't a language I use much.

Would it be possible to check unrecognized args, and if --word-list is one, tell the user to install pyahocorasick?

[lorenzodb1]

@mark-pictor-csec thank you for your suggestion. We will look into that.

[reddybhaskarvengala]

Hi @lorenzodb1 @jpdakran I am able to use --word-list after installing the pyahocorasick package.
Thank you