Skip to content
forked from Checkmarx/ast-cli

A CLI project wrapping application security testing (AST) APIs

License

Notifications You must be signed in to change notification settings

CxFriese/ast-cli

 
 

Repository files navigation


Documentation Contributors Forks Docker Pulls 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:

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

Find more integrations from our team here

© 2022 Checkmarx Ltd. All Rights Reserved.

About

A CLI project wrapping application security testing (AST) APIs

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 99.5%
  • Other 0.5%