# Stackhawk CLI

> For AI agents: the complete documentation index is at https://buddy.works/llms.txt

Learn how to integrate Buddy with StackHawk security testing within one deployment workflow.

## What is StackHawk CLI?

StackHawk CLI is a command-line interface tool designed to help developers **automate application security testing**. 

By using it, users can identify and address vulnerabilities in their web applications, improving the overall security of their software.

Integrating Buddy with the tool allows you to **incorporate security testing into your CI/CD workflow**. With the **StackHawk CLI** action, you can perform various security-related tasks, such as scanning your web applications for vulnerabilities and interpreting the scan results.

A sample pipeline can consist solely of the **StackHawk CLI** action with commands that perform the required security checks:

![Example of StackHawk CLI action in pipeline](https://buddy.works/docs/integrations/stackhawk/stackhawk-1.png) 

In case an issue is detected, adding the **Slack** action to the On failure scenario will ensure that your team gets notified and can take action:

![Pipeline example with on failure section](https://buddy.works/docs/integrations/stackhawk/stackhawk-2.png)

## Setting up StackHawk CLI integration

1. Navigate to the Integrations tab in Buddy and click **New integration**.

2. Look up and click **StackHawk CLI**:

![StackHawk CLI integration selection](https://buddy.works/docs/integrations/stackhawk/stackhawk-5.png)

3. A configuration window will show up:

![StackHawk CLI integration configuration](https://buddy.works/docs/integrations/stackhawk/stackhawk-6.png)

Here you need to provide:

- Integration name
- Application key

> **Info**
>
> You can adjust the privacy configuration options of your integration (i.e. who can use it and where) in the Sharing tab.

4. Once done, click **New integration** to finish configuration.

### Obtaining StackHawk CLI application key

1. In your StackHawk account, head to Settings → [API Keys](https://app.stackhawk.com/settings/apikeys) and click **Create New Api Key**:
 
![Creating API key in StackHawk](https://buddy.works/docs/integrations/stackhawk/stackhawk-3.png)

2. Once the pop-up appears, enter the name for the integration in StackHawk. Click **Continue** and copy the created key:

![Configuring API key details](https://buddy.works/docs/integrations/stackhawk/stackhawk-4.png)

3. Paste the created key in the integration configuration window in Buddy.


---
Original source: https://buddy.works/docs/integrations/stackhawk-cli