# CircleCI
### Common Build Integration Documentation
This documentation is specific to CircleCI. [Common build server](https://docs.threatrix.io/integrations/build-integrations) documentation should be reviewed before proceeding further.
### Environment Variables
Environment variable values can be found in your [user profile](https://docs.threatrix.io/threat-center-1/user-profile).
* THREATRIX\_OID - Your organization ID.
* THREATRIX\_EID - Your entityID (if you wish to override your default).
* THREATRIX\_API\_KEY - Personal or organization API key.
### Install Environment Variables
{% hint style="warning" %}
This step may require administrative privileges within CircleCI
{% endhint %}
From within CircleCI navigate to "Organization Settings->Contexts"
Click the Create Context button and create a new Context named "Threatrix"
After creating the context, click on the name to add environment variables to the context.
From within the Add Environment Variable dialog, enter the necessary variable values.
* THREATRIX\_OID - Your organization ID.
* THREATRIX\_EID - Your entityID (if you wish to override your default).
* THREATRIX\_API\_KEY - Personal or organization API key.
## Add the Threatrix Agent to your build server.
First,Add threatrix context to your job
### Option 1: Add CLI Threat Agent
From within your SCM repository, add the following snippet to your .circleci/config.yml file or download a full example here:
{% file src="" %}
config.yml
{% endfile %}
```yaml
# Execute Threat Scan
- run:
name: Install Threatrix ThreatAgent & Scan
command: |
curl -LJO https://github.com/threatrix/threat-matrix/releases/download/agent-release-latest/threat-agent-latest.jar
java -jar /tmp/threatagent.jar --progress
```
### Option 2: Add Docker Threat Agent Step to your build
{% hint style="warning" %}
**Prerequisite: In order to use our Docker image, your build executor must be of type `machine` otherwise, we'll be unable to create the necessary Docker volume**
{% endhint %}
Add the following code snippet as a step to your existing build job. The threatrix scan agent should run either before or in parallel with your build job.
```
- run:
name: Threatrix Scan
command: |
printenv > host.env
docker run -v $(pwd):/app --env-file=host.env threatrix/threat-agent ./
```
