misp-modules-cli

misp-modules-cli is a lightweight command-line client for querying MISP expansion modules from a local or remote misp-modules service.
It can:
- Auto-detect likely MISP attribute types from a raw value.
- Query matching expansion modules.
- Restrict queries to one or more specific modules.
- List supported input types and active module/type mappings from live module introspection.
- Store per-module configuration (API keys, usernames, etc.) in a local config file.
Requirements
- Python 3.10+ (recommended)
misp-modules running and reachable (default: http://127.0.0.1:6666)
- Python dependency:
Install dependencies:
python3 -m pip install -r requirements.txt
Optional development/build tooling:
python3 -m pip install -r requirements-dev.txt
Install as a package (editable mode):
python3 -m pip install -e .
After installation, you can use the console command directly:
Quick start
1) List supported input types and active modules
python3 bin/cli.py --list-supported-types
python3 bin/cli.py --list-supported-types --verbose-types
python3 bin/cli.py --list-active-modules
python3 bin/cli.py --list-active-modules --verbose-types
--list-supported-types groups active modules by supported attribute type. --list-active-modules shows the inverse view: active modules with the supported attribute types declared by each module.
2) Query with automatic type guessing
python3 bin/cli.py --value 8.8.8.8 --show-guesses
python3 bin/cli.py --value CVE-2024-3094 --show-guesses
3) Query with an explicit MISP type
python3 bin/cli.py --type domain --value circl.lu
4) Restrict to selected modules
python3 bin/cli.py --type domain --value circl.lu --module circl_passivedns
python3 bin/cli.py --type domain --value circl.lu --module circl_passivedns,dns
python3 bin/cli.py --type domain --value circl.lu --module circl_passivedns --module dns
5) Emit unified JSON output from all queried modules
python3 bin/cli.py --value 8.8.8.8 --unified-output
python3 bin/cli.py --type domain --value circl.lu --module circl_passivedns,dns --unified-output
6) Emit markdown report output with summary + full query details
# Print markdown report to stdout
python3 bin/cli.py --value 8.8.8.8 --markdown-output
# Write markdown report to a file
python3 bin/cli.py --type domain --value circl.lu --markdown-output report.md
Module configuration
Some modules require settings (for example credentials or API keys). You can store these once in a local config file.
Interactive configuration
python3 bin/cli.py --configure-module circl_passivedns
Non-interactive configuration
python3 bin/cli.py --configure-module circl_passivedns \
--set username=my-user \
--set password=my-pass
Config file location
Default path:
~/.config/misp-modules-cli/config.json
Override it per run:
python3 bin/cli.py --config-file /path/to/config.json ...
Useful options
--url – base URL of misp-modules service.
--describe-types-url – URL to MISP describeTypes.json.
--list-supported-types – list supported input attribute types and the active modules supporting each type.
--list-active-modules – list active expansion modules and the input attribute types each module supports.
--verbose-types – expand nested details for --list-supported-types or --list-active-modules.
--show-guesses – show guessed attribute types.
--all-guesses – query all guessed types (instead of only the best match).
--raw – print raw JSON responses.
--show-empty-results – include empty module responses in output (hidden by default).
--unified-output – print one merged JSON object containing all module query results.
--markdown-output [PATH] – print a markdown report (or write it to PATH) with summary, query timestamps, query parameters, and responses.
--module – limit queries to specific module name(s).
--cache-file – cache file path for module responses.
--cache-ttl-seconds – cache TTL in seconds (default: 43200, i.e. 12 hours).
--purge-cache – delete the local cache file and exit.
Response cache
To reduce API calls and improve response times, module query responses are cached locally by default.
~/.cache/misp-modules-cli/cache.json
- Default TTL: 12 hours (
43200 seconds)
You can override the cache TTL per run:
python3 bin/cli.py --value 8.8.8.8 --cache-ttl-seconds 3600
Purge the local cache:
python3 bin/cli.py --purge-cache
See all CLI options:
python3 bin/cli.py --help
Exit behavior
- Returns non-zero when required input is missing or API/introspection cannot be fetched.
- Prints errors and diagnostic information to stderr.
License
This project is licensed under the GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later). See LICENSE.