Metadata-Version: 2.5
Name: embtrace-check
Version: 0.3.0
Summary: CRA Readiness Check collector — scans your project's lockfiles and uploads dependency metadata only (never code, never paths). Open source so you can verify exactly what leaves your machine.
Project-URL: Homepage, https://embtrace.dev/check
Project-URL: Source, https://github.com/Innomatica-GmbH/embtrace-check
Project-URL: Privacy, https://embtrace.dev/check-privacy
Author-email: Innomatica GmbH <office@innomatica.de>
License: MIT License
        
        Copyright (c) 2026 Innomatica GmbH
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: compliance,cra,cyber-resilience-act,dependencies,embedded,sbom
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Security
Classifier: Topic :: Software Development :: Quality Assurance
Requires-Python: >=3.11
Requires-Dist: click>=8.1
Requires-Dist: pydantic>=2.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: rich>=13.0
Provides-Extra: dev
Requires-Dist: mypy>=1.10; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff<0.17,>=0.16; extra == 'dev'
Description-Content-Type: text/markdown

# embtrace-check

**Free CRA Readiness Check collector** — one command in your project folder,
and within 24 hours you receive a report showing where your product stands
with the [EU Cyber Resilience Act](https://embtrace.dev/en/cra-nis2-guide.html):
traffic-light readiness status, your full component inventory, and known
vulnerabilities with severity.

This collector is **open source for one reason: so you can verify exactly
what leaves your machine.**

## What it transmits — and what it never does

Transmitted (JSON, ~a few kB):

- names, versions and package ecosystems of your dependencies
  (from lockfiles and build files: Conan, vcpkg, CMake, Cargo, npm/yarn/pnpm,
  Python, Go, Maven/Gradle, Meson, and more),
- the project folder name (hash it with `--anonymize`),
- scan statistics (number of build files, tool version).

**Never transmitted:** source code, file paths, file contents, configuration,
credentials. See for yourself before sending anything:

```bash
embtrace-check . --dry-run     # prints the exact payload, uploads nothing
```

## Usage

1. Get your free one-time code at **<https://embtrace.dev/check>**
   (the report goes to the e-mail address you register there).
2. Run the collector in your project folder:

```bash
pipx install embtrace-check         # or: pip install embtrace-check,
                                    #     or download the standalone binary
embtrace-check . --code CHK-XXXX-YYYY
```

3. Your report arrives within 24 hours. The code is valid for one check.

More options: `embtrace-check --help` — including `--output payload.json`
for air-gapped environments (send the file by mail) and `--with-tools` to
additionally use native package-manager CLIs for higher-fidelity results.

## Exit codes

| Code | Meaning |
|------|---------|
| 0    | success |
| 1    | error (network, invalid code, …) |
| 2    | no components found — declare dependencies manually in `embtrace-deps.yaml` |

## Privacy

Data is processed exclusively on Innomatica's own servers in Germany and is
never shared or sold. Full notes: <https://embtrace.dev/check-privacy>.

## About

`embtrace-check` is the free entry point to
[embtrace](https://embtrace.dev) — the CRA/NIS2 compliance toolchain for
embedded software teams by [Innomatica GmbH](https://embtrace.dev/impressum.html).
The server side (enrichment, vulnerability monitoring, reports) is a
commercial product; this repository contains the complete client.

Maintained by Innomatica; the roadmap follows the product. Issues and PRs are
welcome — please report security topics per [SECURITY.md](SECURITY.md).

## License

[MIT](LICENSE) © 2026 Innomatica GmbH
