Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug] DaC detection_rules help texts are cut off #4517

Open
111andre111 opened this issue Mar 4, 2025 · 0 comments · May be fixed by #4518
Open

[Bug] DaC detection_rules help texts are cut off #4517

111andre111 opened this issue Mar 4, 2025 · 0 comments · May be fixed by #4518
Assignees
Labels
bug Something isn't working Team: TRADE

Comments

@111andre111
Copy link

Describe the Bug

Help texts are some how cut off on different help texts with ....
E.g. these:

Usage: detection_rules [OPTIONS] COMMAND [ARGS]...
  Commands for detection-rules repository.
Options:
  -D, --debug / -N, --no-debug  Print full exception stacktrace on errors
  -h, --help                    Show this message and exit.
Commands:
  build-limited-rules     Import rules from json, toml, or Kibana...
  build-threat-map-entry  Build a threat map entry.
  create-rule             Create a detection rule.
  custom-rules            Commands for supporting custom rules.
  dev                     Commands related to the Elastic Stack rules...
  es                      Commands for integrating with Elasticsearch.
  export-rules-from-repo  Export rule(s) and exception(s) into an...
  generate-rules-index    Generate enriched indexes of rules, based on a...
  import-rules-to-repo    Import rules from json, toml, or yaml files...
  kibana                  Commands for integrating with Kibana.
  mass-update             Update multiple rules based on eql results.
  normalize-data          Normalize Elasticsearch data timestamps and sort.
  rta                     Commands related to Red Team Automation (RTA)...
  rule-search             Use KQL or EQL to find matching rules.
  test                    Run unit tests over all of the rules.
  toml-lint               Cleanup files with some simple toml formatting.
  typosquat               Commands for generating typosquat detections.
  validate-all            Check if all rules validates against a schema.
  validate-rule           Check if a rule staged in rules dir validates...
  view-rule               View an internal rule or specified rule file.

To Reproduce

Just execute these helps:
python3 -m detection_rules --help
python3 -m detection_rules dev --help
Maybe there are still others

Expected Behavior

One example is export-rules-from-repo.
It shows in the help text:

Export rule(s) and exception(s) into an...

however looking to the official repo file it should be

Export rule(s) and exception(s) into an importable ndjson file.

Screenshots

No response

Desktop - OS

None

Desktop - Version

No response

Additional Context

No response

@111andre111 111andre111 added bug Something isn't working Team: TRADE labels Mar 4, 2025
@eric-forte-elastic eric-forte-elastic linked a pull request Mar 4, 2025 that will close this issue
5 tasks
@eric-forte-elastic eric-forte-elastic linked a pull request Mar 4, 2025 that will close this issue
5 tasks
@eric-forte-elastic eric-forte-elastic self-assigned this Mar 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working Team: TRADE
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants