codescan-export
v1.0.7
Published
Export CodeScan issues from the command line
Downloads
11
Readme
codescan-export
CSV export is available in CodeScan Cloud with this command line tool available through npm.
Prerequisites
You will need:
- A CodeScan Cloud account.
- npm installed - Installation Instructions
Installation
There are 2 ways to install the CodeScan Export tool.
Install from Git
- Clone the repository.
- Navigate to the folder in your command line.
- Type npm install -g
- Once the installation is finished, type codescan-export -v to check the tool is available.
Install from npm
- In your command line, type npm install -g codescan-export
- Once the installation is finished, type codescan-export -v to check the tool is available.
Usage
It is recommended that you create an environment variable for your CodeScan Cloud token to avoid using it in plaintext for each call. Name the variable CODESCAN_TOKEN
and assign it the token created in your Account Security Settings.
With the token set as an environment variable you can run the tool with the following command.
codescan-export [ORGANISATION KEY] [PROJECT KEY]
How to find your Organisation Key
Without the token set as an environment variable you can run the tool with the following command. Click on the links for information on how to find the keys.
CODESCAN_TOKEN=[TOKEN] codescan-export [ORGANISATION KEY] [PROJECT KEY]
How to find your Organisation Key
Type codescan-export -h
to see the detailed usage for this tool including how to filter the issues.