With noir, you can view the help documentation using the -h or --help flags.

noir -h 

Requirements arguments

By default, you need to specify the source code directory to analyze using the -b or --base-path flag.

noir -b <BASE_PATH>

# noir -b .s
# noir -b ./app_directory

Outputs

noir -b <BASE_PATH> -f <FORMAT>

# You can check the format list with the -h flag.
#     -f FORMAT, --format json         Set output format
#                                       * plain yaml json jsonl markdown-table
#                                       * curl httpie oas2 oas3
#                                       * only-url only-param only-header only-cookie
FormatDescription
plainOutputs the results in plain text format.
yamlOutputs the results in YAML format.
jsonOutputs the results in JSON format.
jsonlOutputs the results in JSON Lines format, where each line is a JSON object.
markdown-tableOutputs the results in a Markdown table format.
curlOutputs the results as curl commands.
httpieOutputs the results as httpie commands.
oas2Outputs the results in OpenAPI Specification v2 format.
oas3Outputs the results in OpenAPI Specification v3 format.
only-urlOutputs only the URLs found in the analysis.
only-paramOutputs only the parameters found in the analysis.
only-headerOutputs only the headers found in the analysis.
only-cookieOutputs only the cookies found in the analysis.