Perform a file scan

Bridge CLI can be used to run Signal to perform an AI assessment of local files or directories in a project, independent of Git history.

The scanned files and folders can be controlled using include and optional exclude path lists.

Prerequisites

The following prerequisites are required to run a local files scan:

Download the latest version of Bridge, if you haven't installed it already.

https://repo.blackduck.com/bds-integrations-release/com/blackduck/integration/bridge/binaries/bridge

Add Bridge to your $PATH variable.
Save a valid LLM API key in the BRIDGE_SIGNAL_LLM_KEY environment variable.
```
export BRIDGE_SIGNAL_LLM_KEY=<LLM_API_KEY>
```
Run the Bridge CLI Signal workflow at the root level of your project.
```
bridge-cli --stage signal \
  signal.mode=FILES \
  signal.include="src/main,src/dev,pom.xml" \
  signal.exclude="src/dev/resources/generated"
```
Bridge will use the configuration to start Signal to perform an AI assessment of files and folders in the project directory. When the scan has completed, the following outputs will be provided:
- A SARIF report file will be generated at .bridge/signal-controller/results.sarif within the current working directory where Bridge CLI was called from.
- An exit code of 0 will be issued to signal success.

The following parameters enable further customization. Use the related links information section to access the reference guide for the commands.

CLI Argument	Description
`project.directory`	By default Black Duck Signal scans the files and folders in the current working directory. This behavior can be overridden by specifying the absolute path for the `project.directory` argument.
`signal.version`	By default Bridge downloads the latest version of Signal from the Black Duck repository. This behavior can be overridden by specifying a version string, e.g. `0.2.9`.
`signal.args`	Specify additional arguments to be passed directly to Signal, e.g. `"--dataflow true --log-level debug"`.