README-EN.md

codemillx

English | 简体中文

codemillx is a tool for CodeQL, extract the comments in the code and generate codeql module.

Installation

To install codemillx use the go get command:

go get github.com/hudangwei/codemillx/cmd/codemillx

Run

Navigate to your web application folder and execute:

cd mywebapp && codemillx ./...

Requirements

To allow cqlgen to format the generated codeql, you need a recent version of the codeql cli (otherwise it will not be formatted), and have it available as codeql in your PATH.

codeql query format -qq -i Customizations.qll

How to add comments in your code?

• Declarative Comments Format

Usage

• How to use Customizations.qll file into Github CodeQL Action

Reference

• codemill