A CodeQL tool to automatically execute code scanning.
npm install codeql-agent[![NPM version][npm-version-image]][npm-url]
[![NPM downloads][npm-downloads-image]][npm-downloads-url]
[![MIT License][license-image]][license-url]
CodeQL Agent CLI is a tool that automates the process of using CodeQL, a semantic code analysis engine, to execute code scanning. It makes the process of finding security vulnerabilities in code simple and efficient.
- CodeQL Agent CLI
- Features
- Requirements
- Install CodeQL Agent CLI
- Getting Started
- Usage
- Using CodeQL Agent on VSCode
- Contributors
- License
- Automated CodeQL from detect language, create database and scan.
- Scan remote target (e.g. GitHub repository) or local target (e.g. source code folder). Support scan list of target.
- Support running on Docker which prepackaged and precompiled CodeQL for running code scanning (under development).
- Send results to Discord webhook.
- For normal use, you need to install the CodeQL CLI.
- For Docker support, you need to install Docker and are not required to install CodeQL CLI.
Install CodeQL Agent CLI from npm:
``bash`
npm install -g codeql-agent
1. Install CodeQL Agent CLI.
`bash`
npm install -g codeql-agent
2. Scan your codebase.
`bash`
codeql-agent scan
`bash`
codeql-agent -h
or for more details about command:
`bash`
codeql-agent scan -h
This will display help for the tool. Here are all the switches of scan command supports.
`console |/ _ \ | | | | / _ \ / _
____ _ ___ _ _ _
/ ___|___ __| | ___ / _ \| | / \ __ _ ___ _ __ | |_
| | / _ \ / _ |/ _ \ '_ \| __|
| |__| (_) | (_| | __/ |_| | |___ / ___ \ (_| | __/ | | | |_
\____\___/ \__,_|\___|\__\_\_____| /_/ \_\__, |\___|_| |_|\__|
|___/
Author: doublevkay - Version: 0.3.4
Usage: codeql-agent scan [options]
scan a target. Target could be source code folder, remote repository (e.g. GitHub repository) or a list of target.
Arguments:
target source code folder, remote repository or list of target.
Examples:
codeql-agent scan src/sammple
codeql-agent scan targets.txt
codeql-agent scan https://github.com/OWASP/NodeGoat
Options:
-l, --language
language.
-o, --output
If you want to use CodeQL Agent on VSCode, you can install the CodeQL Agent extension from the VSCode Marketplace.
This tool is released by CodeQL Agent Project - a non-profit organization from community and are not the official team of CodeQL, under the MIT License. For the full text of this, please consult our LICENSE.md file.
Note that this license applies only to the tool in this repository, for more information on the license governing use of the CodeQL CLI that it uses, please consult the GitHub CodeQL Terms and Conditions. In particular, note that there are restrictions on how you may use the the CodeQL CLI on code that is not released under an OSI-approved open source software license.
[npm-url]: https://npmjs.org/package/codeql-agent
[npm-version-image]: https://img.shields.io/npm/v/codeql-agent.svg?style=flat
[npm-downloads-image]: https://img.shields.io/npm/dm/codeql-agent.svg?style=flat
[npm-downloads-url]: https://app.fossa.com/projects/git%2Bgithub.com%2Fcodeql-agent-project%2Fcodeql-agent?ref=badge_large
[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat
[license-url]: LICENSE