detection-rules icon indicating copy to clipboard operation
detection-rules copied to clipboard

Update README for the installation of kibana and kql packages

Open pberba opened this issue 4 months ago • 2 comments

Pull Request

Issue link(s):

Summary - What I changed

Updated Getting started section to the correct way to install the kibana and kql packages from the repository. Using the following

pip3 install git+https://github.com/elastic/detection-rules.git#subdirectory=kibana
pip3 install git+https://github.com/elastic/detection-rules.git#subdirectory=kql

Results in this error

ERROR: git+https://github.com/elastic/detection-rules.git#subdirectory=kibana does not appear to be a Python project: neither 'setup.py' nor 'pyproject.toml' found.

How To Test

Checklist

  • [ ] Added a label for the type of pr: bug, enhancement, schema, maintenance, Rule: New, Rule: Deprecation, Rule: Tuning, Hunt: New, or Hunt: Tuning so guidelines can be generated
  • [ ] Added the meta:rapid-merge label if planning to merge within 24 hours
  • [ ] Secret and sensitive material has been managed correctly
  • [ ] Automated testing was updated or added to match the most common scenarios
  • [ ] Documentation and comments were added for features that require explanation

Contributor checklist

pberba avatar Oct 02 '25 12:10 pberba

❌ Author of the following commits did not sign a Contributor Agreement: 584d9149ed157284ab3d76a7eb4cf68d8c7a1d2c, f34246b9c9c6b3d60f41e5ecb784790a574a08c5

Please, read and sign the above mentioned agreement if you want to contribute to this project

👋 Thanks for the submission @pberba . Once you sign the CLA, this should be g2g.

Mikaayenson avatar Oct 03 '25 13:10 Mikaayenson