Skip to content

Commit

Permalink
Add command line usage to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Col-E committed Aug 20, 2023
1 parent dd06ba5 commit 63c4cab
Showing 1 changed file with 32 additions and 1 deletion.
33 changes: 32 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,35 @@ For code examples on using Concoction as a library, see [the test cases](concoct

### As a command line application

> Not yet implemented
Usage as shown from `--help`:
```shell
Usage: Concoction [-h] [-v] [-V] [-dd=<directoryDepth>] [-i=<input>]
[-id=<inputDir>] [-im=<archiveMode>] [-m=<model>]
[-md=<modelDir>] [-rcm=<consoleOutputMode>]
Dynamic Shared Malware Scanner
-dd, --dirDepth=<directoryDepth>
Directory depth to scan for with --modelDir and
--inputDir
-h, --help Show this help message and exit.
-i, --input=<input> Path to single file to scan (jar)
-id, --inputDir=<inputDir>Directory containing files to scan (jar)
-im, --inputMode=<archiveMode>
Mode to use when parsing jar/zip files.
- RANDOM_ACCESS_JAR: Used when inputs are loaded
dynamically via 'java.util.zip.ZipFile' or 'java.
util.zip.JarFile'
- RUNNABLE_JAR: Used when inputs are treated
as a program run via 'java -jar' or 'java -cp'
- STREAMED_JAR: Used when inputs are loaded
dynamically via streaming such as with 'java.util.
zip.ZipInputStream' or 'java.util.zip.
JarInputStream'

-m, --model=<model> Path to single concoction scan model file (json)
-md, --modelDir=<modelDir>Directory containing concoction scan model files
(json)
-rcm, --resultsConsoleMode=<consoleOutputMode>
Console output display mode for results
-v, --verbose Enables more verbose logging and error details
-V, --version Print version information and exit.
```

0 comments on commit 63c4cab

Please sign in to comment.