Nuclei Action makes it easy to orchestrate Nuclei with GitHub Action. Integrate all of your Nuclei Templates into powerful continuous security workflows and make it part of your secure software development life cycle.
.github/workflows/nuclei.yml
on:
workflow_dispatch:
schedule:
- cron: "0 10 * * *"
jobs:
worker:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- uses: actions/cache@v2
id: cache
with:
path: /home/runner/go/bin/nuclei
key: ${{ runner.os }}-${{ hashFiles('/home/runner/go/bin/nuclei') }}
- uses: projectdiscovery/nuclei-action@main
with:
urls: "urls.txt"
templates: "nuclei-templates"
output: "nuclei.log"
- uses: actions/upload-artifact@v2
with:
name: nuclei.log
path: nuclei.log
Example with nuclei generating an ISSUE with the report:
.github/workflows/nuclei.yml
on:
workflow_dispatch:
schedule:
- cron: "0 10 * * *"
jobs:
worker:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- uses: actions/cache@v2
id: cache
with:
path: /home/runner/go/bin/nuclei
key: ${{ runner.os }}-${{ hashFiles('/home/runner/go/bin/nuclei') }}
- uses: projectdiscovery/nuclei-action@main
with:
urls: "urls.txt"
github-report: true
report-token: ${{ secrets.GITHUB_TOKEN }}
Key | Description | Required |
---|---|---|
urls |
List of urls to run templates | true |
templates |
Templates input file/files to check across hosts | false |
output |
File to save output result | false |
include-rr |
Include request/response in log | false |
nuclei-ignore |
Define templates that will be blocked from execution | false |
user-agent |
Set a User-Agent header | false |
github-report |
Set true for generate an issue with the report |
false |
report-token |
Set the Github Token | false |