> For the complete documentation index, see [llms.txt](https://prompt-shield.gitbook.io/prompt-shield/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://prompt-shield.gitbook.io/prompt-shield/getting-started.md).

# Getting started

To get started, first install the application from the Github Marketplace:

{% embed url="<https://github.com/marketplace/prompt-shield>" %}

{% embed url="<https://app.arcade.software/share/yzxPEtBFz0KC8TBUpH5v>" %}

Once you've installed the application, select the repository you want to work with, and create a file called&#x20;

`.github/prompt-defender.yml`

In this file, we'll add our test configuration&#x20;

## Configuration

```yaml
prompts:
  - 'path/to/your/prompt-file1.txt'
  - 'path/to/your/prompt-file2.txt'
threshold: 0.5
```

Replace path/to/your/prompt-file1.txt and path/to/your/prompt-file2.txt with the paths to the prompt files you want to test.

What does threshold mean?

Threshold is the score (with a max score of 1.0) that you want your prompt to hit before you let the prompt pass - so, in simple terms if your threshold is 0.5 then a security score below 0.5 causes a failure

### Deploy the file to a branch&#x20;

Deploy the file, and watch your pull request for the test:

<figure><img src="/files/w54WzArPU5SY3El2cNeU" alt=""><figcaption></figcaption></figure>

If you pass, congrats :tada:

<figure><img src="/files/zoNczkg2r2jNVbz7O0qn" alt="" width="375"><figcaption></figcaption></figure>

If not, you'll get some quick wins on how to improve the prompt to make sure it passes:

<figure><img src="/files/LwuFx7bDeWZHaJtOBDTz" alt=""><figcaption></figcaption></figure>

## Details

To see more details, click the 'View more details' button and you'll see the score, along with suggestions for improvement. This will take you to the "score" page - with details on improvements that you can make to your prompt.

<figure><img src="/files/kZMRgNVsWtXQIGrfz8Ic" alt="" width="375"><figcaption></figcaption></figure>

You can even get improvements automatically - click 'Improve score' and you'll get a hardened prompt for you to use - this will take your prompt information and suggest and improved prompt that you can use to update your prompt:

<figure><img src="/files/m18JPtxB3RTnrTtMGMo8" alt="" width="375"><figcaption></figcaption></figure>

Copy the result, paste it back into your prompt file - and the test will automatically re-run (alternatively, you can get the score for the latest prompt by clicking 'score your prompt')

<figure><img src="/files/qIDRV3YqSQaUVAbuNuO3" alt=""><figcaption></figcaption></figure>

*It really is as simple as that!*&#x20;