Skip to content

Commit

Permalink
Add AI security considerations in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nvuillam committed Jan 12, 2025
1 parent 1255afe commit e62c66a
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

Note: Can be used with `sfdx plugins:install sfdx-hardis@beta` and docker image `hardisgroupcom/sfdx-hardis@beta`

- Add AI security considerations in documentation

## [5.15.1] 2025-01-12

- Improve prompt templates
Expand Down
10 changes: 10 additions & 0 deletions docs/salesforce-ai-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,16 @@ description: Learn how to use AI to supercharge sfdx-hardis deployments

# Setup AI for sfdx-hardis

## Security considerations

sfdx-hardis uses **prompt via API** to collect analysis: only **Metadata XML** or **JSON deployment errors** are sent in the prompts.

If you follow Flows best practices and **do not hardcode credentials / tokens in variables**, there is no serious risk to send metadata XML to an external LLM (**but be aware that you do !**)

You can see the prompts content if you set env variable `DEBUG_PROMPTS=true`.

The list of prompts used by sfdx-hardis is defined in [this source file](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/src/common/aiProvider/promptTemplates.ts).

## Main configuration

You need to define at least env variable OPENAI_API_KEY and make it available to your CI/CD workflow.
Expand Down

0 comments on commit e62c66a

Please sign in to comment.