README.md

AST CLI Maven Plugin

The AST CLI Maven Plugin allows you to use the AST CLI inside Maven.
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

The AST CLI Maven Plugin allows you to use the AST CLI inside Maven.

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• Maven
• Access to a CxAST account (oauth2 client or an API Key)

Installation

1. Clone the repo

   https://github.com/CheckmarxDev/ast-cli-maven-plugin

2. Install the Maven package

   mvn install

Usage

Configure your credentials and run the following goal:

com.checkmarx:ast-cli-maven-plugin:0.0.1:run "-Darguments=..." -f pom.xml

Check this page for possible arguments.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Checkmarx - AST Integrations Team

Project Link: https://github.com/CheckmarxDev/ast-cli-maven-plugin

Find more integrations from our team here

© 2022 Checkmarx Ltd. All Rights Reserved.