README.md

AST-CLI-JAVASCRIPT-WRAPPER

Table of Contents

1. About The CxProject
2. Getting Started
   • Prerequisites
   • Setting Up
3. Contact

About The CxProject

The Javascript-Wrapper is part of the AST-CLI project that provides a shared infrastructure across the AST projects. It contains technology neutral repository interfaces as well as a metadata model for persisting Javascript classes.

Getting Started

Package configuration

Add the following dependency:

"dependencies": {
    "@checkmarxdev/ast-cli-javascript-wrapper": "{version}"
}

Prerequisites

To be able to build the code you should have:

• Node

Setting Up

In your terminal, run:

- npm install

To run integrations tests, you need to set up environment variables:

• In Linux systems run in terminal:

export CX_CLIENT_ID="{value}"
export CX_CLIENT_SECRET="{value}"
export CX_APIKEY="{value}"
export CX_BASE_URI="{value}"
export CX_BASE_AUTH_URI="{value}"
export CX_TENANT="{value}"
export PATH_TO_EXECUTABLE="{value}"

• In Windows systems run in powershell:

setx CX_CLIENT_ID {value}
setx CX_CLIENT_SECRET {value}
setx CX_APIKEY {value}
setx CX_BASE_URI {value}
setx CX_BASE_AUTH_URI {value}
setx CX_TENANT {value}
setx PATH_TO_EXECUTABLE {value}

Contact

Checkmarx - AST Integrations Team

CxProject Link: https://github.com/CheckmarxDev/ast-cli-javascript-wrapper

© 2021 Checkmarx Ltd. All Rights Reserved.