↑ ↓ to navigate
    ↵ to select
    esc to close
    OWASP Noir

    Running Noir

    Learn the basic commands to get started with Noir. This guide shows you how to run a scan on a directory and view the available command-line options.

    Basic Scan

    Analyze a codebase using the -b or --base-path flag:

    Scan current directory:

    noir -b .

    Scan subdirectory:

    noir -b ./my_app

    Viewing Help Information

    View all available commands and flags:

    noir -h

    Checking Supported Technologies

    List supported languages and frameworks:

    noir --list-techs

    Output Formats

    Default output is table format. Available formats:

    JSON Output

    noir -b . -f json

    YAML Output

    noir -b . -f yaml

    OpenAPI Specification

    noir -b . -f oas3

    Suppressing Logs

    Clean output without log messages:

    noir -b . --no-log

    Verbose Output

    Detailed information output:

    noir -b . --verbose

    Output Customization

    Control what information is displayed in plain text output:

    Include File Paths

    Show source file paths in results:

    noir -b . --include-path

    Include Technology Information

    Show detected technology/framework for each endpoint:

    noir -b . --include-techs

    Both flags can be combined:

    noir -b . --include-path --include-techs