# Semgrep: scan source with your own rule



Scan source with your own rule.



## 1. Run the example



[Download the Semgrep example](https://www.security.run/docs/examples/semgrep.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 report.json for matches from the local rule, with source locations.



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



- `rules/local.yml`

- `src/a.py`

- `src/b.py`



The example uses supplied files or the disposable execution environment. Nothing from the environment carries into a later run unless you request and reuse its output.



Qualified version: `1.145.0`. Commands: `semgrep`.



- Supply local rules for disconnected runs; registry rule downloads require network access.



Inspect `GET /v1/tools/semgrep` 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": "semgrep",
  "timeout_seconds": 90,
  "invocation": {
    "args": [
      "scan",
      "--config",
      "rules",
      "--json",
      "--metrics=off",
      "--disable-version-check",
      "--output",
      "report.json",
      "src"
    ],
    "outputs": [
      "report.json"
    ],
    "success_exit_codes": [
      0
    ],
    "executable": "semgrep",
    "files": [
      {
        "path": "rules/local.yml",
        "artifact_id": "artifact_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "executable": false
      },
      {
        "path": "src/a.py",
        "artifact_id": "artifact_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "executable": false
      },
      {
        "path": "src/b.py",
        "artifact_id": "artifact_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "executable": false
      }
    ]
  }
}
```