Getting Started
#
Installationgem install goodcheck
Or you can use Bundler:
bundle add goodcheck
If you would not like to install Goodcheck to your system (e.g. you would not like to install Ruby), you can use our Docker images.
#
Docker imagesWe provide the Docker images for Goodcheck so that you can try Goodcheck without installing it to your system. Visit our Docker Hub page for more details.
For example:
docker run -t --rm -v "$(pwd):/work" sider/goodcheck check
The default latest
tag points to the latest version of Goodcheck.
You can pick any version of Goodcheck from the released tags.
#
Quickstartgoodcheck init
# Edit goodcheck.yml
goodcheck check
- Generate a template of
goodcheck.yml
configuration file for you. - Edit the
goodcheck.yml
to define patterns you want to check. - Run checking your files, and it will print matched texts.
See the commands for more details.
#
CheatsheetYou can download a printable cheatsheet from this repository.