https://github.com/stelligent/config-lint

Command line tool to validate configuration files
https://github.com/stelligent/config-lint

config-lint continuous-testing devops hacktoberfest json kubernetes lint open-source static-analysis stelligent terraform yaml

Last synced: 3 months ago
JSON representation

Command line tool to validate configuration files

• Host: GitHub
• URL: https://github.com/stelligent/config-lint
• Owner: stelligent
• License: mit
• Created: 2018-03-23T21:16:51.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-02-22T20:58:02.000Z (9 months ago)
• Last Synced: 2024-06-19T05:57:18.144Z (5 months ago)
• Topics: config-lint, continuous-testing, devops, hacktoberfest, json, kubernetes, lint, open-source, static-analysis, stelligent, terraform, yaml
• Language: HCL
• Homepage: https://stelligent.github.io/config-lint/#/
• Size: 1.45 MB
• Stars: 192
• Watchers: 34
• Forks: 39
• Open Issues: 36
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-devsecops-russia - Config-lint

README

        
[![Latest Release](https://img.shields.io/github/v/release/stelligent/config-lint?color=%233D9970)](https://img.shields.io/github/v/release/stelligent/config-lint?color=%233D9970)

[![Build & Deploy](https://github.com/stelligent/config-lint/workflows/Build%20%26%20Deploy/badge.svg)](https://github.com/stelligent/config-lint/workflows/Build%20%26%20Deploy/badge.svg)

[![Go Report Card](https://goreportcard.com/badge/github.com/stelligent/config-lint)](https://goreportcard.com/report/github.com/stelligent/config-lint)

# 🔍 config-lint 🔎

A command line tool to validate configuration files using rules specified in YAML. The configuration files can be one of several formats: Terraform, JSON, YAML, with support for Kubernetes. There are built-in rules provided for Terraform, and custom files can be used for other formats.

📓 [Documentation](https://stelligent.github.io/config-lint)

👷 [Contributing](CONTRIBUTING.md)

🐛 [Issues & Bugs](https://github.com/stelligent/config-lint/issues)

## Blog Posts

✏️ [config-lint: Up and Running](https://stelligent.com/2020/04/17/config-lint-up-and-running/)

✏️ [Development Acceleration Through VS Code Remote Containers](https://stelligent.com/2020/04/10/development-acceleration-through-vs-code-remote-containers-setting-up-a-foundational-configuration/)

## Quick Start

Install the latest version of config-lint on macOS using [Homebrew](https://brew.sh/):

``` bash

brew tap stelligent/tap

brew install config-lint

```

Or manually on Linux:

``` bash

curl -L https://github.com/stelligent/config-lint/releases/latest/download/config-lint_Linux_x86_64.tar.gz | tar xz -C /usr/local/bin config-lint

chmod +rx /usr/local/bin/config-lint

```

Run the built-in ruleset against your Terraform files. For instance if you want to run config-lint against our [example files](example-files/):

``` bash

config-lint -terraform example-files/config

```

You will see failure and warning violations in the output like this:

``` bash

[

  {

    "AssertionMessage": "viewer_certificate[].cloudfront_default_certificate | [0] should be 'false', not ''",

    "Category": "resource",

    "CreatedAt": "2020-04-15T19:24:33Z",

    "Filename": "example-files/config/cloudfront.tf",

    "LineNumber": 10,

    "ResourceID": "s3_distribution",

    "ResourceType": "aws_cloudfront_distribution",

    "RuleID": "CLOUDFRONT_MINIMUM_SSL",

    "RuleMessage": "CloudFront Distribution must use TLS 1.2",

    "Status": "FAILURE"

  },

  ...

```

You can find more install options in our [installation guide](/docs/install.md).