golangci-lint/docs/src/docs/usage/quick-start.mdx
Isaev Denis 2d4d503a79
docs: migrate README.md to a website (#1094)
Make a website https://golangci-lint.run
for golangci-lint documentation.
The website is backed by Gatsby static site generator
and deployed into Netlify.
2020-05-16 14:10:03 +03:00

45 lines
809 B
Plaintext

---
title: Quick Start
---
To run golangci-lint execute:
```bash
golangci-lint run
```
It's an equivalent of executing:
```bash
golangci-lint run ./...
```
You can choose which directories and files to analyze:
```bash
golangci-lint run dir1 dir2/... dir3/file1.go
```
Directories are NOT analyzed recursively. To analyze them recursively append `/...` to their path.
GolangCI-Lint can be used with zero configuration. By default the following linters are enabled:
```bash
$ golangci-lint help linters
{.LintersCommandOutputEnabledOnly}
```
and the following linters are disabled by default:
```bash
$ golangci-lint help linters
...
{.LintersCommandOutputDisabledOnly}
```
Pass `-E/--enable` to enable linter and `-D/--disable` to disable:
```bash
golangci-lint run --disable-all -E errcheck
```