Git Product home page Git Product logo

ast-cli's Introduction

Contributors Forks Stargazers Issues MIT License


Logo

AST-CLI

Checkmarx CLI is a standalone Checkmarx tool.
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact

About The Project

The tool is a fully functional Command Line Interface (CLI) that interacts with the Checkmarx CxAST server.

The tool is able to perform all the functions that the REST APIs support, so the CLI users can perform all the tasks that are related to managing the Checkmarx CxAST server.

The CLI tool supports the following actions:

  • Manage Checkmarx projects (create / delete / show)
  • Manage Checkmarx scanning (create / cancel / delete / show) Display scan results

The CLI also acts as the backbone for all the supported plugins. All the plugins use the CLI tool to initiate scans. This allows minimal updates to the plugins which decreases the need for constant updates and feature requests.

The tool is universal that can manage all the CxAST scan types (CxSAST, CxSCA, KICS, etc.).


Getting Started

Installing the CLI tool is very simple.

Prerequisites

To be able to build the code you should have:

  • Go
 You can download and install Go using this link: https://golang.org/doc/install

Setting Up

Windows

setx GOOS=windows 
setx GOARCH=am
go build -o ./bin/cx.exe ./cmd

Linux

export GOARCH=amd64
export GOOS=linux
go build -o ./bin/cx ./cmd

Macintosh

export GOOS=darwin 
export GOARCH=amd64
go build -o ./bin/cx-mac ./cmd

Usage

To see how you can use our tool, please refer to the Documentation

Contribution

We appreciate feedback and contribution to the CLI! Before you get started, please see the following:


License

Distributed under the Apache 2.0. See LICENSE for more information.

Contact

Checkmarx - AST Integrations Team

Project Link: https://github.com/Checkmarx/ast-cli

© 2021 Checkmarx Ltd. All Rights Reserved.

ast-cli's People

Contributors

daniel-amsellem avatar davidcheckmarx avatar tsunez avatar ronenl2 avatar dannyboy412 avatar igor-cx avatar pedrompflopes avatar fjsnogueira avatar diogopcx avatar dependabot[bot] avatar andregcx avatar hmmachadocx avatar jay-nanduri avatar tiagobcx avatar yaelpery avatar kmcdon83 avatar kojanabzakh avatar miguelfreitas93 avatar cxariav avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.