regscale/regscale-cli

RegScale 命令行界面 (CLI)

镜像概述和主要用途

RegScale CLI是一款支持RegScale合规自动化平台的命令行应用，用于高级自动化和批量数据处理。该应用设计为“侧车”模式，可通过CRON任务或无服务器函数调度，执行复杂的数据处理操作。CLI包含多个数据处理库、RegScale API连接工具及商业集成组件，可打包至其他商业软件中，降低构建RegScale与其他商业工具集成的难度。

完整文档请参见https://regscale.readme.io/docs/overview%E3%80%82

核心功能和特性

• 支持RegScale平台的高级自动化与批量数据处理
• 提供数据处理、API连接及商业集成的多类库
• 可作为“侧车”通过CRON任务或无服务器函数调度
• 支持生成REST API服务器，通过API调用执行CLI功能
• 日志输出至stdout和stderr，支持调试日志模式

使用场景和适用范围

• 作为侧车处理合规数据（如漏洞扫描或持续监控日志）
• 处理和摄入NIST OSCAL（开放安全控制评估语言）等数据
• 运行CRON任务进行批量数据处理
• 从外部源管理用户和身份
• 集成威胁情报源

详细使用方法和配置说明

安装

从Docker Hub拉取最新镜像：

shell
# 拉取最新镜像
docker pull regscale/regscale-cli:latest

# 通过容器运行命令
docker run regscale/regscale-cli:latest about

# 创建长期运行的后台容器并命名为'regscale-cli'（将保留init.yaml配置）
docker run -itd --name regscale-cli regscale/regscale-cli:latest

### 或 ###

# 进入容器
docker run -it --entrypoint /bin/bash regscale/regscale-cli:latest

# 执行CLI
regscale --help

# 退出容器（不会保留init.yaml配置）
exit

初始化

使用init命令初始化CLI环境：

shell
# 进入长期运行的容器并执行CLI命令
docker exec -it regscale-cli bash

# 初始化RegScale CLI环境
regscale init

### 或 ###

# 进入容器
docker run -it --entrypoint bash regscale/regscale-cli:latest

# 初始化RegScale CLI环境
regscale init

CLI将生成默认init.yaml文件，并提示输入RegScale域名和登录信息：

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: gson
Please enter your password:

使用不同入口点

CLI提供多个入口点用于运行不同命令：

• 默认入口点：regscale，用于运行CLI命令
• bash入口点：用于进入容器
• regscale-rest入口点：创建REST API服务器，通过REST API调用CLI

shell
# 以REST API服务器模式运行容器并暴露端口5555
docker run -itd --name cli-rest -p 5555:5555 --entrypoint regscale-cli-rest regscale/regscale-cli:latest

# 调用REST API并输出结果
curl --silent localhost:5555/about | jq -r .output

# 通过浏览器访问RegScale CLI REST API文档：http://localhost:5555/swagger
# 或使用CLI网页上传工具：http://localhost:5555/

日志

CLI日志输出至stdout和stderr。可通过设置LOGLEVEL环境变量为DEBUG启用调试日志：

shell
# 进入容器并设置LOGLEVEL环境变量为DEBUG
docker run -it --entrypoint bash -e LOGLEVEL=DEBUG regscale/regscale-cli:latest

# 通过容器名称查看日志
docker logs regscale-cli

### 或 ###

# 通过docker ps查看容器ID
docker ps

# 查看容器日志
docker logs <container-id>

特定集成

详情参见https://regscale.readme.io/docs/overview%E3%80%82