search

Fraunhofer-AISEC / codyze

Codyze is a static analyzer for Java, C, C++ based on code property graphs
https://www.codyze.io
Apache License 2.0
86 stars 18 forks source link

Include documentation about the CLI mode #13

Closed oxisto closed 4 years ago

oxisto commented 4 years ago

We should include basic documentation about the CLI mode in the codyze binary.

JulianSchuette commented 4 years ago

codyze --help gives the following usage output

Usage: codyze (-c | -l | -t) [[--typestate=<NFA|WPDS>] [--interproc]] [-hV] [-m=<path>] [-o=<file>]
              [-s=<path>] [--timeout=<minutes>]
Codyze finds security flaws in source code
  -s, --source=<path>       Source file or folder to analyze.
  -m, --mark=<path>         Load MARK policy files from folder
  -o, --output=<file>       Write results to file. Use -- for stdout.
      --timeout=<minutes>   Terminate analysis after timeout
                              Default: 120
  -h, --help                Show this help message and exit.
  -V, --version             Print version information and exit.
Execution mode
  -c                        Start in command line mode.
  -l                        Start in language server protocol (LSP) mode.
  -t                        Start interactive console (Text-based User Interface).
Analysis settings
      --typestate=<NFA|WPDS>
                            Typestate analysis mode
                            NFA:  Non-deterministic finite automaton (faster, intraprocedural)
                            WPDS: Weighted pushdown system (slower, interprocedural)
      --interproc           Enables interprocedural data flow analysis (more precise but slower).

as described in the documentation: https://www.codyze.io/docs/getting-started/cli/

What else would you expect?

JulianSchuette commented 4 years ago

Closing. Please re-open if there is need for additional documentation.