CircleCI – ShellCheck Wiki

Sitemap

Shellcheck can be run on CircleCI in a variety of ways:

Via CircleCI Orbs

CircleCI provides a circleci/shellcheck orb that can be used in any CircleCI workflow:

https://circleci.com/orbs/registry/orb/circleci/shellcheck

version: 2.1

orbs:
  shellcheck: circleci/shellcheck@2.0.0

workflows:
  shellcheck:
    jobs:
      - shellcheck/check

Manually

Simply copy and paste the existing installation instructions into a run step in your CircleCI job.

For example:

version: 2.1

jobs:
  build:
    macos:
      xcode: "9.0"
    steps:
      - checkout
      - run: brew install shellcheck

Or, in a Linux-based image:

version: 2.1

jobs:
  build:
    machine: true
    steps:
      - checkout
      - run: apt-get install shellcheck

ShellCheck is a static analysis tool for shell scripts. This page is part of its documentation.