# ShellCheck

Gives warnings and suggestions about `bash`/`sh` shell scripts.

1. [TL;DR](#tldr)
1. [Further readings](#further-readings)

## TL;DR

<details>
  <summary>Installation and configuration</summary>

```sh
apt install 'shellcheck'
brew install 'shellcheck'
pacman -S 'shellcheck'
zypper in 'ShellCheck'
```

</details>
<details>
  <summary>Usage</summary>

```sh
shellcheck '/path/to/script.sh'
shellcheck '/path/to/scripts/*.sh'
```

</details>

## Further readings

- [Website]
- [Github]

<!--
  Reference
  ═╬═Time══
  -->

<!-- In-article sections -->
<!-- Knowledge base -->
<!-- Files -->
<!-- Upstream -->
[github]: https://github.com/koalaman/shellcheck
[website]: https://www.shellcheck.net/

<!-- Others -->
