detectiq 0.1.42

A detection engineering workbench with LLM capabilities, including SigmaIQ features

DetectIQ

DetectIQ is an AI-powered security rule management library. It helps create, analyze, and optimize detection rules for various security platforms.

⚠️ IMPORTANT DISCLAIMER This project is a Proof of Concept and under active development. Expect bugs, breaking changes, and incomplete documentation. Not recommended for production use. Use at your own risk.

Quickstart

1. Clone: git clone https://github.com/AttackIQ/DetectIQ.git && cd DetectIQ
2. Configure: Copy .env.example to .env and add your API keys (e.g., OPENAI_API_KEY).
3. Install: poetry install --all-extras (recommended) or pip install .
4. Explore: See the examples/ directory and the detailed documentation.

Key Features

• AI-powered rule creation and optimization (OpenAI).
• Integration with rule repositories (SigmaHQ, YARA-Forge, Snort3).
• Static analysis of samples (malware, PCAPs) for rule generation context.
• Multi-platform SIEM query translation.

For more details, see documentation.

Road Map

Key areas of future development include support for custom/local LLMs, more SIEM integrations, and enhanced rule validation. See issues for more.

Using as a Package

Install from PyPI: pip install detectiq

DetectIQ is primarily used as a Python library. For detailed usage patterns and code examples, please refer to the examples/ directory and the main documentation.

Environment Configuration

Configure via environment variables. Copy .env.example to .env and set your API keys. For full details, see the documentation.

Development

This project uses a Makefile for common development tasks.

• Install development dependencies: poetry install --all-extras (includes dev dependencies if pyproject.toml is configured for it, or use a specific group e.g. poetry install --with dev). Check your Makefile or pyproject.toml for the exact command for dev dependencies.
• View available commands: make help
• Format code: make format
• Run tests: make test

For publishing information, see PUBLISHING.md.

Contributing

1. Fork the repository.
2. Create a feature branch.
3. Commit your changes.
4. Push to the branch.
5. Create a Pull Request.

License

This project uses multiple licenses. The core project is licensed under LGPL v2.1. See the LICENSE file and notes on licenses for bundled rule sets within the documentation.

Support & Community

• Discussions: SigmaHQ Discord
• Issues: GitHub Issues

Acknowledgments

• SigmaHQ Community
• YARA-Forge Contributors
• Snort Community
• OpenAI