regscale-cli 6.29.18.6
Command Line Interface (CLI) for bulk processing/loading data into RegScale
License: MIT
Requires Python: <4,>=3.10

# RegScale Command Line Interface (CLI)

This CLI application is for supporting advanced automation and bulk data processing related to the [RegScale Compliance Automation Platform](https://www.regscale.com).  This application is intended to run as a "side car" that be scheduled via CRON job or serverless function to perform sophisticated data processing.  The CLI includes multiple libraries for processing data, connecting to RegScale Application Programming Interfaces (APIs), and commercial integrations.  This software may be packaged and included in other commercial software to lower the level of effort associated with building RegScale integrations to other commercial tools.

See [full documentation on regscale.readme.io](https://regscale.readme.io/docs/overview).


## Installation

Create a virtual environment and install required Python libraries.

### MacOS/Linux
```shell
# create and activate python virtual environment
python -m venv venv

# initialize environment
source venv/bin/activate

# upgrade pip
pip install --upgrade pip

# install RegScale CLI
pip install regscale-cli

# optional: install application with "server" packages
pip install "regscale-cli[server]"
```

### Windows
```PowerShell
# create and activate python virtual environment
python -m venv venv

# initialize environment
.\venv\Scripts\Activate.ps1

# upgrade pip
pip install --upgrade pip

# install RegScale CLI
pip install regscale-cli

# optional: install application with "server" packages
pip install "regscale-cli[server]"
```

## Initialization

Initialize your CLI environment with the `init` command:

```shell
# initialize RegScale CLI environment
regscale init
```

The CLI will generate a default init.yaml file and prompt you for RegScale domain and to log in:

```shell
Initializing your RegScale CLI environment...
Would you like to change your RegScale domain from https://regscale.yourcompany.com/? (Y/n): y

Please enter your RegScale domain.
Example: https://mydomain.regscale.com/
Domain: https://regscale.mycomapny.com
[2023/01/20 04:32;41] INFO     [2023/01/20 04:32;41] [INFO ]  Valid URL provided, regscale.py:349
                               init.yaml has been updated.
Would you like to log in to your RegScale instance? (Y/n): y
Please enter your username: rross
Please enter your password:
```

## Leaving the Virtual Environment

When you are done working with the CLI, you can leave the virtual environment with the `deactivate` command. This will return you to your system's default Python environment and this will work on PowerShell or shell.


## Use Cases

- Sidecar for bulk processing compliance data such as vulnerability scans or continuous monitoring logs
- Processing and ingest of data such as National Institute of Standards and Technology (NIST) Open Security Control Assessment Language (OSCAL)
- Running CRON jobs to bulk-process data
- Managing users and identities from external sources
- Threat intelligence feeds

## Specific Integrations

- See the [RegScale Documentation](https://regscale.readme.io/docs/overview) for details.