https://github.com/simp/rubygem-simp-compliance_engine
https://github.com/simp/rubygem-simp-compliance_engine
hacktoberfest
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/simp/rubygem-simp-compliance_engine
- Owner: simp
- License: apache-2.0
- Created: 2024-04-10T17:52:25.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-08T22:21:01.000Z (over 1 year ago)
- Last Synced: 2025-04-13T05:53:09.919Z (about 1 year ago)
- Topics: hacktoberfest
- Language: Ruby
- Homepage:
- Size: 85 KB
- Stars: 2
- Watchers: 7
- Forks: 1
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# ComplianceEngine
Work with [Sicura](https://sicura.us/) (formerly [SIMP](https://simp-project.com/)) Compliance Engine data.
For more information on the Compliance Engine data format and how to use it, see [the SCE documentation](https://simp-project.com/docs/sce/).
## Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add compliance_engine
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install compliance_engine
## Usage
### CLI
`compliance_engine` provides a CLI for interacting with Compliance Engine data.
```
Commands:
compliance_engine dump # Dump all compliance data
compliance_engine help [COMMAND] # Describe available commands or one specific command
compliance_engine hiera --profile=one two three # Dump Hiera data
compliance_engine inspect # Start an interactive shell
compliance_engine lookup KEY --profile=one two three # Look up a Hiera key
compliance_engine profiles # List available profiles
compliance_engine version # Print the version
Options:
[--facts=FACTS]
[--enforcement-tolerance=N]
[--module=one two three]
[--modulepath=one two three]
[--modulezip=MODULEZIP]
```
### Library
See the [`ComplianceEngine::Data`](https://rubydoc.info/gems/compliance_engine/ComplianceEngine/Data) class for details.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/simp/rubygem-simp-compliance_engine.