Add CLI tool to extract rule information with JSON output#2978
Draft
Add CLI tool to extract rule information with JSON output#2978
Conversation
Co-authored-by: BernieWhite <13513058+BernieWhite@users.noreply.github.com>
Co-authored-by: BernieWhite <13513058+BernieWhite@users.noreply.github.com>
Co-authored-by: BernieWhite <13513058+BernieWhite@users.noreply.github.com>
Co-authored-by: BernieWhite <13513058+BernieWhite@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] [FEATURE] Tool to extract information from rules and docs
Add CLI tool to extract rule information with JSON output
Jul 10, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a new
get rulecommand to the PSRule CLI tool that extracts rule metadata and outputs it in JSON format for pipeline automation.What's Changed
ps-rule get rulecommand with comprehensive options--path,--module,--name,--baseline,--include-dependencies,--no-restoreUsage
JSON Output Structure
{ "rules": [ { "ruleName": "Security.TLS", "displayName": "Use TLS 1.2+", "synopsis": "Ensure TLS 1.2 or higher is used", "description": "TLS versions below 1.2 have known vulnerabilities", "recommendation": "Configure services to use TLS 1.2 or higher", "moduleName": "Security.Rules", "severity": "High", "tags": { "category": "Security", "type": "Protocol" }, "annotations": { "version": "1.0.0", "author": "Security Team" }, "labels": { "environment": "Production" } } ] }Benefits for Pipeline Automation
This command enables easy programmatic access to rule information for:
The JSON output format makes it simple to consume rule metadata in any language or tool that can parse JSON.
Fixes #2977.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.