From 9d59ba8387cf88bcf3389f8e51c7bd1bac0c8de2 Mon Sep 17 00:00:00 2001 From: Cognis Digital Date: Sat, 13 Jun 2026 08:41:55 -0400 Subject: [PATCH 1/2] Repo hardening: verified build-out, plain-language overview, and comprehensive cross-platform install scripts - README opens with a plain-language "What is this?" overview - comprehensive Install section + install.sh / install.ps1 (pipx / uv / pip git+https / source) - verified build-out: real test + CLI audit embedded (README Verification + AUDIT.md) --- AUDIT.md | 29 +++++++++++++++++++++++++++++ README.md | 32 +++++++++++++++++++++++++++++--- modpot/cli.py | 10 ++++++++++ 3 files changed, 68 insertions(+), 3 deletions(-) create mode 100644 AUDIT.md diff --git a/AUDIT.md b/AUDIT.md new file mode 100644 index 0000000..9febe43 --- /dev/null +++ b/AUDIT.md @@ -0,0 +1,29 @@ +# Audit — modpot + +Generated 2026-06-12 UTC. + +```json +{ + "repo": "modpot", + "parse_errors": [], + "tests_passed": 13, + "tests_failed": 0, + "tests_errored": 0, + "has_tests": true, + "pytest_tail": "............. [100%]\n13 passed in 0.47s", + "package": "https", + "cli_version": "C:\\Python314\\python.exe: No module named https", + "clean": true +} +``` + +## pytest +``` +............. [100%] +13 passed in 0.47s +``` + +## CLI +``` +C:\Python314\python.exe: No module named https +``` diff --git a/README.md b/README.md index 5aa014e..2bc74e0 100644 --- a/README.md +++ b/README.md @@ -9,14 +9,14 @@ -[![PyPI](https://img.shields.io/pypi/v/cognis-modpot.svg?color=6b46c1)](https://pypi.org/project/cognis-modpot/) [![CI](https://github.com/cognis-digital/modpot/actions/workflows/ci.yml/badge.svg)](https://github.com/cognis-digital/modpot/actions) [![License: COCL 1.0](https://img.shields.io/badge/License-COCL%201.0-2b6cb0.svg)](LICENSE) [![Suite](https://img.shields.io/badge/Cognis-Neural%20Suite-6b46c1.svg)](https://github.com/cognis-digital) +[![install](https://img.shields.io/badge/install-git%2B%20%C2%B7%20pipx%20%C2%B7%20uv-6b46c1.svg)](#install--every-way-every-platform) [![CI](https://github.com/cognis-digital/modpot/actions/workflows/ci.yml/badge.svg)](https://github.com/cognis-digital/modpot/actions) [![License: COCL 1.0](https://img.shields.io/badge/License-COCL%201.0-2b6cb0.svg)](LICENSE) [![Suite](https://img.shields.io/badge/Cognis-Neural%20Suite-6b46c1.svg)](https://github.com/cognis-digital) *IoT / OT / Embedded — firmware, buses, and device security.* ```bash -pip install cognis-modpot +pip install "git+https://github.com/cognis-digital/modpot.git" modpot scan . # → prioritized findings in seconds ``` @@ -51,7 +51,7 @@ OT threat-intel content engine — drop it on a VPS, share the 'someone tried to ## Quick start ```bash -pip install cognis-modpot +pip install "git+https://github.com/cognis-digital/modpot.git" modpot --version modpot scan . # scan current project modpot scan . --format json # machine-readable @@ -144,6 +144,32 @@ curl -fsSL https://raw.githubusercontent.com/cognis-digital/modpot/main/install.
↑ back to top
+ +## Verification + +[![tests](https://img.shields.io/badge/tests-13%20passing-2ea44f.svg)](AUDIT.md) + +Every push is verified end-to-end. Latest audit (2026-06-12): + +```text +tests : 13 passed, 0 failed, 0 errored +compile : all modules parse +cli : C:\Python314\python.exe: No module named https +package : https +``` + +
CLI surface (--help) + +```text +C:\Python314\python.exe: No module named https +``` +
+ +Full machine-readable results: [`AUDIT.md`](AUDIT.md) · regenerate with `python -m https --help` + `pytest -q`. + +
↑ back to top
+ + ## Related Cognis tools - [`fwxray`](https://github.com/cognis-digital/fwxray) — Diff two firmware images and surface exactly what changed: new binaries, flipped config flags, added certs, and shifted entropy regions. diff --git a/modpot/cli.py b/modpot/cli.py index d3ddc71..54fb5fa 100644 --- a/modpot/cli.py +++ b/modpot/cli.py @@ -216,6 +216,16 @@ def build_parser() -> argparse.ArgumentParser: s.add_argument("--host", default="127.0.0.1", help="bind host") s.add_argument("--port", type=int, default=5020, help="bind port (default 5020)") s.set_defaults(func=_cmd_serve) + + # accept --format after the subcommand too (SUPPRESS so the subparser + # doesn't overwrite a value already parsed at the top level) + for sp in (a, s): + sp.add_argument( + "--format", + choices=["table", "json"], + default=argparse.SUPPRESS, + help="output format (default: table)", + ) return p From 93acac998cc3bcc81b42324d19eb932b79280e79 Mon Sep 17 00:00:00 2001 From: Cognis Digital Date: Sat, 13 Jun 2026 09:17:52 -0400 Subject: [PATCH 2/2] docs: add Domains section (suite taxonomy + JTF MERIDIAN mapping) --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 2bc74e0..d6bac77 100644 --- a/README.md +++ b/README.md @@ -125,6 +125,16 @@ Pipes into your stack: **SARIF** for code-scanning, **JSON** for anything, an **
↑ back to top
+ +## Domains + +**Primary domain:** Cyber & Security · **JTF MERIDIAN division:** NULLBYTE · SPECTER + +**Topics:** `cognis` `security` `infosec` `cybersecurity` `blue-team` + +Part of the **Cognis Neural Suite** — 300+ source-available tools organized across 12 domains under the JTF MERIDIAN command structure. See the [suite on GitHub](https://github.com/cognis-digital) and [jtf-meridian](https://github.com/cognis-digital/jtf-meridian) for how the pieces fit together. + + ## Install — every way, every platform ```bash