docs
- Commands:
opengrep scan,opengrep test, etc. - Flags: command-line flags and the commands that accept them.
- Rule syntax: elements of the YAML definition of a rule.
- Pattern syntax: code patterns and their placeholders, such as
...and$X. - Rule options: settings under the
optionskey of a rule. - Environment variables: variables read by Opengrep.
- Internal and debugging interfaces: interfaces for the development and testing of Opengrep.
Further reading
The Opengrep wiki on GitHub contains tutorials and notes on the internals of the taint analysis:
- Intrafile taint tracking: following tainted data from function to function within one file, with
--taint-intrafile. - Taint tracking in higher-order functions: taint carried through callbacks such as
mapandforEach. - Built-in methods that taint: standard library methods, such as
list.addandmap.get, that carry taint into and out of collections, for each language. - Guarded taint signatures: an experimental refinement that drops a finding when the condition leading to the sink can never hold for a call.