RegScale-CLI 1.0.5

Command Line Interface (CLI) for bulk processing/loading data into RegScale

RegScale Command Line Interface (CLI)

This CLI application is for supporting advanced automation and bulk data processing related to the RegScale Compliance Automation Platform. 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.

Use Cases

• Sidecar for bulk processing compliance data such as vulnerability scans or continuous monitoring logs
• Ingest of data such as National Institute of Standards and Technology (NIST) Open Security Control Assessment Language (OSCAL)
• Running CRON job to bulk process data
• Processing NIST OSCAL artifacts
• Bulk user management with Active Directory
• Integration with 3rd party scanning tools such as:
  • Wiz.io
  • Tenable Security
• ITIL ticket creation and processing such as:
  • ServiceNow
  • Jira

Development Using the CLI

Build and install our new tool in the virtual environment to test locally (NOTE: If on Windows, may use the py prefix instead of python3):

python3 setup.py develop

This command build a local instance of the CLI for testing. Run the "About" example to test:

regscale about

WARNING - this site is under construction

The CLI is currently in BETA and planned for version 1.0 General Availability in late Spring or early Summer of 2022.

Packaging and Deploying the CLI

To package for distribution, run the following command (make sure to update the version in setup.py first):

python3 setup.py sdist bdist_wheel

Publish to PyPi:

twine upload --repository testpypi --skip-existing dist/*

RegScale CLI should now be available at: https://test.pypi.org/project/RegScale-CLI

Using the CLI

Read the Online Docs for More Info on Installing, Configuring, and Using the CLI

References

• Python Click Documentation
• Wiz.io API Documentation
• Building a Python CLI
• RegScale PyPI Page