Apex
This article shows you how to analyze your Apex code using Qwiet AI by Harness.
Requirements
See Prerequisites for more information.
Analyzing your Apex code
To analyze your Apex code, run:
sl analyze --app <name> --apex [<path>]
| Parameter | Description |
|---|---|
--app <name> | The name of the project/module to be analyzed (maximum length: 100 characters) |
--apex | The flag identifying the code as Apex |
<path> | The path to the code to be analyzed |
See the CLI reference for additional sl analyze options.
Additional parameters
The analysis accepts additional parameters after a double hyphen --.
For example, the following ignores files listed in the referenced ignore list:
sl analyze --app <name> --apex . -- --ignore-list ignorelist.txt
Where ignorelist.txt contains one file path per line. For example:
./src/classes/Test1.cls
./src/classes/Test2.cls
| Parameter | Description |
|---|---|
--ignore-list <path> | Path to file containing a list of files to ignore, one path per line |
--threads <num> | Sets the number of threads used for the analysis. Set to 0 to disable multi-threading processing. Default is 1 |
Tagging results with your branch name
To include the branch name in your Qwiet AI by Harness results, allowing you to distinguish one set of results from another, add the following to your invocation of Qwiet:
sl analyze --tag branch=`git symbolic-ref --short HEAD`
If you're working in a GitHub environment (e.g., GitHub Actions), you can also use --tag branch=${{ github.head_ref }} to populate your branch name.
If you don't provide a branch name, but Qwiet detects one available in your environment, it will use that name.