README.md

checkctl

CLI for opengovernance

Installation

brew tap kaytu-io/cli-tap && brew install checkctl

List of Commands

• configure
• get
  • benchmarks
  • compliance-summary-for-benchmark
  • compliance-summary-for-integration
  • controls
  • jobs
  • job-details
  • findings
• run compliance
• run discovery

Configure

Configuration for checkctl

Interactive mode:

checkctl configure 

Non-interactive mode:

checktl configure --api-key <<api-key>> --app-endpoint https://path.to.app.endpoint --output json

---

NOTE: Pre-defined integartions can be manually added to the configuration file, by updating the integrations field inside $HOME/.checkctl/config.json.

config.json:

{
    ...
    "integrations": {"acc3":"id_name=account3"}
}

---

get

benchmarks

Get a list of benchmarks

Available flags:

Flag	Description	Default
--page-size	Defines page size of response	25
--page-number	Defines page number of response	1
--show-only-root	Show only root benchmarks	true
--include-findings-summary	Include findings summary in response	false

controls

Get a list of controls

Available flags:

Flag	Description	Default
--page-size	Defines page size of response	25
--page-number	Defines page number of response	1