# codethreat-cli

> A CLI tool to integrate with CodeThreat services for code scanning and threat detection.

Latest version **0.63.0** (published 2023-11-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install codethreat-cli
pnpm add codethreat-cli
yarn add codethreat-cli
bun add codethreat-cli
```

Provides the command `codethreat`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.63.0 |
| Published | 2023-11-01 |
| First published | 2023-09-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 17.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | CodeThreat |
| Maintainers | codethreat |
| Keywords | codethreat, cli, security, code-scanning, threat-detection |

## Links

- npm: https://www.npmjs.com/package/codethreat-cli
- Repository: https://github.com/CodeThreat/codethreat-cli
- Homepage: https://github.com/CodeThreat/codethreat-cli#readme
- Issues: https://github.com/CodeThreat/codethreat-cli/issues
- npm.io page: https://npm.io/package/codethreat-cli

## Dependencies (6)

- [axios](https://npm.io/package/axios.md) ^1.6.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [archiver](https://npm.io/package/archiver.md) ^6.0.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^11.1.1
- [form-data](https://npm.io/package/form-data.md) ^4.0.0
- [cli-progress](https://npm.io/package/cli-progress.md) ^3.12.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.63.0 (latest) — 2023-11-01
- 0.62.0 — 2023-11-01
- 0.61.0 — 2023-09-06

## README

---

<!-- PROJECT LOGO -->
<br />
<p align="center">
  <a href="https://codethreat.com">
    <img src="https://www.codethreat.com/_next/static/media/ct-logo.0cc6530f.svg" alt="Logo" width="259" height="39">
  </a>

  <h3 align="center">CodeThreat CLI</h3>

</p>
[CodeThreat](https://codethreat.com)

A CLI tool to integrate with CodeThreat services for code scanning.

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
  - [Scan Command](#scan-command)
  - [Configuration](#configuration)

## Installation

```bash
npm install codethreat-cli -g
```

## Usage

### Scan Command

To scan a project:

```bash
codethreat scan <target_dir> -p <project_name>
```

### Configuration

Set up your CodeThreat configuration:

```bash
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.


---

---
_Source: https://npm.io/package/codethreat-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._