Sha256: 884cf5c6f7486e2bc9d5f6ab7adc5e0d5e3619abbe440238e5f4add1fd85fa95
Contents?: true
Size: 1.02 KB
Versions: 8
Compression:
Stored size: 1.02 KB
Contents
--- id: getstarted title: Getting Started sidebar_label: Get Started --- ## Installation ```bash $ gem install goodcheck ``` Or you can use `bundler`! If you would not like to install Goodcheck to system (e.g. you would not like to install Ruby 2.4 or higher), you can use a docker image. [See below](#docker-images). ## Docker Images We provide Docker images of Goodcheck so that you can try Goodcheck without installing them. - https://hub.docker.com/r/sider/goodcheck/ ```bash $ docker pull sider/goodcheck $ docker run -t --rm -v "$(pwd):/work" sider/goodcheck check ``` The default `latest` tag points to the latest release of Goodcheck. You can pick a version of Goodcheck from [tags page](https://hub.docker.com/r/sider/goodcheck/tags). ## Quickstart ```bash $ goodcheck init $ vim goodcheck.yml $ goodcheck check ``` The `init` command generates a template of `goodcheck.yml` configuration file for you. Edit the config file to define patterns you want to check. Then run `check` command, and it will print matched texts.
Version data entries
8 entries across 8 versions & 1 rubygems