skanner
v1.0.0
Published
Simple wrapper for Snyk's CLI
Downloads
1
Maintainers
Readme
███████ ██ ██ █████ ███ ██ ███ ██ ███████ ██████
██ ██ ██ ██ ██ ████ ██ ████ ██ ██ ██ ██
███████ █████ ███████ ██ ██ ██ ██ ██ ██ █████ ██████
██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
███████ ██ ██ ██ ██ ██ ████ ██ ████ ███████ ██ ██
skanner
A wrapper for source code scanners (Snyk)
Requirements
- Snyk CLI v1.1194.0 or above (https://github.com/snyk/cli)
- API token from a service or named Snyk accounts. Use a token from service account for CI or for any automation processes and a token from a named account for local scans.
- Snyk org ID, the scan results will be sent to the Snyk org with this ID
- NodeJs minimum version: 18.17.0
Installation
- Clone the repo
git clone [email protected]:woolworthslimited/skanner.git
- Check the version of node, the minimum version to run skanner is
18.17.0
node -v
- From the folder in the recenlty clonned repo, execute these commands:
npm i
npm i -g .
- Test it by executing this command:
skanner
You should get a result like the one below:
Usage
- From a terminal, move to the folder where the code you want to scan is stored.
- If you haven't authenticated your Snyk CLI, execute
skanner auth <your-snyk-api-token>
orsnyk auth <your-snyk-api-token>
- Execute
skanner code
to trigger a scan with Snyk Code orskanner packs
to trigger a scan with Snyk Open Source.
Contact the AppSec Team for any quesions or issues: [email protected]