Installation

• cURL
  • Linux (amd64, arm64, s390x, ppc64le)
  • macOS (amd64, arm64)
  • Windows (amd64)
• NPM
  • Run
  • NPX
• Docker
• GitHub Action
• Homebrew (macOS, Linux)
• Bazel
  • Build from Source
  • Run from Source

There are several ways for you to install ls-lint without any dependencies.
Linux, macOS & Windows support out of the box

cURL

Linux (amd64, arm64, s390x, ppc64le)

curl -sL -o ls-lint https://github.com/loeffel-io/ls-lint/releases/download/v2.3.0-beta.1/ls-lint-linux-amd64 && chmod +x ls-lint && ./ls-lint

macOS (amd64, arm64)

curl -sL -o ls-lint https://github.com/loeffel-io/ls-lint/releases/download/v2.3.0-beta.1/ls-lint-darwin-arm64 && chmod +x ls-lint && ./ls-lint

Windows (amd64)

Download the .exe manually from GitHub (opens new window)

ls-lint-windows-amd64.exe

NPM

npm install -g @ls-lint/ls-lint@v2.3.0-beta.1 # global
npm install @ls-lint/ls-lint@v2.3.0-beta.1 # local

Run

ls-lint # global
node_modules/.bin/ls-lint # local - use backslashs for windows

NPX

npx @ls-lint/ls-lint@v2.3.0-beta.1

Docker

Based on Google Distroless (opens new window). The Docker image for v2.x is blocked through issue (opens new window) and will be supported soon.

docker run --rm -v /path/to/project:/data lslintorg/ls-lint:1.11.2

GitHub Action

Please see the ls-lint GitHub Action repository (opens new window) for more informations

- uses: actions/checkout@v4
- uses: ls-lint/action@v2.3.0-beta.1

Homebrew (macOS, Linux)

Does not support beta versions

ref: Homebrew (opens new window)

brew install ls-lint

Bazel

Build from Source

ls-lint uses Bazel (opens new window) as primary build system.

bazel build //cmd/ls_lint:ls-lint

Run from Source

bazel run //cmd/ls_lint:ls-lint -- --config ${PWD}/.ls-lint.yml --workdir ${PWD}