codethreat-cli
v0.63.0
Published
A CLI tool to integrate with CodeThreat services for code scanning and threat detection.
Downloads
10
Maintainers
Readme
A CLI tool to integrate with CodeThreat services for code scanning.
Table of Contents
Installation
npm install codethreat-cli -g
Usage
Scan Command
To scan a project:
codethreat scan <target_dir> -p <project_name>
Configuration
Set up your CodeThreat configuration:
codethreat config
And follow the prompts to enter your base URL, organization name, and CT access token.
Sure! Here's the "API Reference" section refined for your README.md
:
API Reference
getProject(projectName)
Fetches a project.
- projectName: The name of the project to fetch.
createProject(projectName)
Creates a new project.
- projectName: The name of the new project.
startScan(projectName, zipFilePath)
Starts a scan for a project.
- projectName: Name of the project to scan.
- zipFilePath: Path to the zipped target directory.
getScanProgress(scanId)
Fetches the progress of a scan.
- scanId: ID of the scan to fetch progress for.