cognis-digital/shipcheck

``` pip install cognis-shipcheck shipcheck scan . # → prioritized findings in seconds ``` ## 目录 - [为什么选择 shipcheck？](#why) · [功能](#features) · [快速开始](#quick-start) · [示例](#example) · [架构](#architecture) · [AI stack](#ai-stack) · [对比](#how-it-compares) · [集成](#integrations) · [随处安装](#install-anywhere) · [相关项目](#related) · [贡献](#contributing) ## 使用 —— 分步指南 `shipcheck` 对 Dockerfile 进行最佳实践、镜像大小和 CVE 漏洞建议的 lint。当发现的问题满足 `--fail-on`（默认为 `medium`）时，退出码为 `1`；遇到文件/使用错误时，退出码为 `2`。 1. **安装** pip install shipcheck 2. **对一个或多个 Dockerfile 进行 lint：** shipcheck lint Dockerfile services/api/Dockerfile 3. **调整拦截严重级别**，使用 `--fail-on {info,low,medium,high,critical}`： shipcheck lint Dockerfile --fail-on high 4. **读取 JSON 输出**，用于仪表盘或策略工具： shipcheck lint Dockerfile --format json | jq '.reports[].findings' 5. **在 CI 中使用** —— `--no-color` 保持日志整洁，退出码会导致构建失败： shipcheck lint Dockerfile --no-color --fail-on medium || exit 1 ## 为什么选择 shipcheck？ 容器 DX `shipcheck` 具有单一用途、可脚本化且支持自托管：将其指向目标，以你的工作流已使用的格式（table · JSON · SARIF）获取优先级排序的结果，通过它来拦截 CI，并让 agent 通过 MCP 驱动它。 ## 功能 - ✅ Lint 文本 - ✅ Lint 文件 - ✅ 可在 Linux/macOS/Windows · Docker · devcontainer 上运行 - ✅ 提供 Python, JavaScript, Go, 和 Rust 的移植版 (`ports/`) ## 快速开始 ``` pip install cognis-shipcheck shipcheck --version shipcheck scan . # scan current project shipcheck scan . --format json # machine-readable shipcheck scan . --fail-on high # CI gate (non-zero exit) ``` ## 示例 ``` $ shipcheck scan . [HIGH ] SHI-001 example finding (./src/app.py) [MEDIUM ] SHI-002 another signal (./config.yaml) 2 findings · risk score 5 · 38ms ``` ## 架构 ``` flowchart LR IN[image / coordinates] --> P[shipcheck
extract + geolocate] P --> OUT[location estimate] ``` ## 从任何 AI stack 中使用它 `shipcheck` 可与每一种流行的 AI 使用方式互操作： - **MCP server** —— `shipcheck mcp` (Claude Desktop, Cursor, Cognis.Studio, [uncensored-fleet](https://github.com/cognis-digital/uncensored-fleet)) - **兼容 OpenAI / JSON** —— 将 `shipcheck scan . --format json` 管道传输给任何 agent 或 LLM - **LangChain · CrewAI · AutoGen · LlamaIndex** —— 一行代码即可将 CLI/JSON 封装为工具 - **CI / 脚本** —— 为非 AI pipeline 提供 exit code + SARIF ## 对比 | | **Cognis shipcheck** | hadolint | |---|:---:|:---:| | 支持自托管，无需账号 | ✅ | 视情况而定 | | 单一命令，零配置 | ✅ | ⚠️ | | 用于 CI 的 JSON + SARIF | ✅ | 视情况而定 | | MCP 原生 (AI agent) | ✅ | ❌ | | 多语言移植版 (JS/Go/Rust) | ✅ | ❌ | | 开放许可证 | ✅ COCL | 视情况而定 | *秉承 **hadolint / dive** 的精神，以 Cognis 的方式重新构建。遗漏了 credit？欢迎提交 PR。* ## 集成 接入你的技术栈：用于代码扫描的 **SARIF**，用于一切的 **JSON**，用于 AI agent 的 **MCP server** (`shipcheck mcp`)，以及用于 SIEM/Slack/Jira 的 webhook 转发器。详见 [`docs/INTEGRATIONS.md`](docs/INTEGRATIONS.md)。 ## 安装 —— 各种方式，各个平台 ``` pip install "git+https://github.com/cognis-digital/shipcheck.git" # pip (works today) pipx install "git+https://github.com/cognis-digital/shipcheck.git" # isolated CLI uv tool install "git+https://github.com/cognis-digital/shipcheck.git" # uv pip install cognis-shipcheck # PyPI (when published) docker run --rm ghcr.io/cognis-digital/shipcheck:latest --help # Docker brew install cognis-digital/tap/shipcheck # Homebrew tap curl -fsSL https://raw.githubusercontent.com/cognis-digital/shipcheck/main/install.sh | sh ``` | Linux | macOS | Windows | Docker | Cloud | |---|---|---|---|---| | `scripts/setup-linux.sh` | `scripts/setup-macos.sh` | `scripts/setup-windows.ps1` | `docker run ghcr.io/cognis-digital/shipcheck` | [DEPLOY.md](docs/DEPLOY.md) (AWS/Azure/GCP/k8s) | ## 相关的 Cognis 工具 - [`mcpforge`](https://github.com/cognis-digital/mcpforge) —— 几分钟内即可搭建、测试并发布 MCP server - [`promptlint`](https://github.com/cognis-digital/promptlint) —— 将 prompt 作为代码进行 lint、版本控制和测试，并带有 CI 拦截 - [`envdoctor`](https://github.com/cognis-digital/envdoctor) —— .env 验证器，提供 secret 存在性检查和 config-drift 检查 - [`apidiff`](https://github.com/cognis-digital/apidiff) —— 针对跨 commit 的 OpenAPI / GraphQL 进行破坏性变更检测 - [`codeglance`](https://github.com/cognis-digital/codeglance) —— Repo 入职地图 —— 为人类和 agent 提供架构概览和热点分析 - [`flakefinder`](https://github.com/cognis-digital/flakefinder) —— 从 CI 历史中检测不稳定的测试，并提供隔离建议 **探索套件 →** [🗂️ 全部 170+ 工具](https://github.com/cognis-digital/cognis-neural-suite) · [⭐ awesome-cognis](https://github.com/cognis-digital/awesome-cognis) · [🔗 cognis-sources](https://github.com/cognis-digital/cognis-sources) · [🤖 uncensored-fleet](https://github.com/cognis-digital/uncensored-fleet) · [🧠 engram](https://github.com/cognis-digital/engram) ## 互操作性 `{}` 与 300+ 工具的 Cognis 套件协同组合 —— JSON 输入/输出以及共享的 兼容 OpenAI 的 `/v1` 骨干网络。详见 **[INTEROP.md](INTEROP.md)** 获取 套件图谱、组合模式和参考技术栈。 ## 许可证 源码可见，基于 **Cognis Open Collaboration License (COCL) v1.0** —— 个人、内部评估、研究和教育用途免费；**商业/生产用途需要许可证** (licensing@cognis.digital)。详见 [LICENSE](LICENSE)。

标签：DevSecOps, Docker, LNA, SOC Prime, 上游代理, 可视化界面, 安全防御评估, 开发工具, 数据可视化, 日志审计, 请求拦截, 逆向工具, 错误基检测, 静态代码分析