# Nuclei: run a custom HTTP template



Run a custom HTTP template.



## 1. Run the example



[Download the Nuclei example](https://www.security.run/docs/examples/nuclei.zip). Extract it, install `httpx`, set your API URL and token, then run `python client.py`. The client uploads the included inputs, submits the command, and saves the result under `results/RUN_ID`.



## 2. Check the result



Read findings.jsonl for matches produced by the supplied template.



Read the native exit code and cleanup status printed by the client. [Read results and save reports](https://www.security.run/docs/visibility.html) explains the returned files.



## 3. Use your own inputs



Edit `example.json` to change the command arguments, requested outputs or deadline. Replace the files under `inputs/` with your own data, keeping the staged paths aligned with the command. The client creates the artifact IDs for you; illustrative IDs shown here must not be copied into a live request.



### Files used by this example



- `templates/check.yaml`



This example selects the isolated `web-fixture` target. To use a reachable target of your own, change the target arguments or driver and remove `target_profile`. See [Run a check against a target](https://www.security.run/docs/targets.html) for network setup.



Qualified version: `3.11.1`. Commands: `nuclei`.



- Supply templates as files; the upstream template corpus is not bundled.



Inspect `GET /v1/tools/nuclei` for the current installed version and readiness. The published snapshot has 1 functional case(s), plus timeout and cancellation checks. These examples demonstrate the native path; other flags and inputs are supported within the tool’s runtime limits.

## Command submitted by the example

```json
{
  "tool": "nuclei",
  "timeout_seconds": 90,
  "invocation": {
    "args": [
      "-u",
      "http://127.0.0.1:8000",
      "-t",
      "/tmp/work/templates",
      "-jsonl",
      "-silent",
      "-duc",
      "-ni",
      "-c",
      "1",
      "-rl",
      "5",
      "-o",
      "findings.jsonl"
    ],
    "outputs": [
      "findings.jsonl"
    ],
    "success_exit_codes": [
      0
    ],
    "executable": "nuclei",
    "files": [
      {
        "path": "templates/check.yaml",
        "artifact_id": "artifact_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "executable": false
      }
    ]
  },
  "target_profile": "web-fixture"
}
```