open-index/open-npm huggingface dataset:
npm package: @remedix/cli
Description: Remedix CLI for automated security scanning
Latest version: 1.0.2

# @remedix/cli

Remedix CLI for automated security scanning. This tool allows you to initiate and monitor security scans directly from your terminal.

## Installation

```bash
npm install -g @remedix/cli
```

Or run it directly using npx:

```bash
npx @remedix/cli scan https://example.com
```

## Configuration

The CLI requires a Remedix API Key. You can provide it in two ways:

1.  **Environment Variable:** Create a `.env` file or export it in your shell:
    ```bash
    export REMEDIX_API_KEY=your_api_key_here
    ```

2.  **Command Line Option:** Use the `--key` or `-k` flag with any command.

## Usage

### Start a Scan

To start a new security scan for a target URL:

```bash
remedix scan https://example.com
```

**Options:**

*   `-k, --key <key>`: Remedix API Key.
*   `-m, --mode <mode>`: Scan mode: `FAST` (default) or `DEEP`.
*   `-s, --scanner <type>`: Scanner type: `ZAP` (default), `AISCANNER`, or `NUCLEI`.
*   `-w, --wait`: Wait for the scan to complete and show results.
*   `--api-url <url>`: Override the default Remedix API URL (default: `https://remedix.app`).

**Example with wait:**

```bash
remedix scan https://example.com --wait --mode DEEP
```

### Check Scan Status

To check the status of an existing scan using its ID:

```bash
remedix status <scan_id>
```

**Options:**

*   `-k, --key <key>`: Remedix API Key.
*   `--api-url <url>`: Override the default Remedix API URL.

## Development

1.  Clone the repository.
2.  Install dependencies:
    ```bash
    npm install
    ```
3.  Build the project:
    ```bash
    npm run build
    ```
4.  Link for local testing:
    ```bash
    npm link
    ```