> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# circleci/github-super-linter

Utilize GitHub's Super-Linter to lint your codebase with multiple linters.


## Jobs

### lint

Lint your codebase with GitHub's Super-Linter.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `scan-dir` | string | . | The relative path in your project to the directory to be linted. By default, all files will be linted. |
| `version` | string | v4 | Pick a specific github/super-linter tag:
https://hub.docker.com/r/github/super-linter/tags
 |

## Examples

### lint-code

Utilize GitHub's Super-Linter to lint your code base with multiple linters.


```yaml
version: '2.1'
orbs:
  github-super-linter: circleci/github-super-linter@1.0
workflows:
  lint-code:
    jobs:
      - github-super-linter/lint
```

### lint-code-with-options

Super-Linter supports a range of optional flags as well as two build in parameters.
Environment Variables: Env vars can be attached to existing jobs via CircleCI Contexts.


```yaml
version: '2.1'
orbs:
  github-super-linter: circleci/github-super-linter@1.0
workflows:
  lint-code-with-options:
    jobs:
      - github-super-linter/lint:
          context: Super-Linter-Options
          scan-dir: src
          version: v4
```