The inventory format
Everything one part contains on one commit, and how it was taken. Version 1.
watchdep inventory --json writes it; watchdep scan sends it to a server, which checks it against the same schema before storing anything. It holds names, versions, file paths and the commit. It never holds source code.
The shape
{
"schema_version": "1",
"cli_version": "0.1.0",
"taken_at": "2026-11-12T09:30:00Z",
"taken_by": "cli",
"part": {
"root": ".",
"commit": "a41f9c2e8d0b7c5f3a1e9d4b6c8a2f0e1d3b5c7a",
"branch": "main",
"production_branch": "main"
},
"packages": [
{
"ecosystem": "RubyGems",
"name": "rack",
"version": "2.2.3",
"range": "",
"purl": "pkg:gem/rack@2.2.3",
"scope": "production",
"scope_recorded": true,
"relation": "transitive",
"source_file": "Gemfile.lock",
"paths": [
[
{
"name": "sidekiq",
"version": "6.5.8"
},
{
"name": "rack",
"version": "2.2.3"
}
]
],
"more_paths": 10,
"paths_recorded": true
}
],
"os_packages": [],
"runtimes": [],
"images": [],
"files_read": [
{
"path": "Gemfile.lock",
"ecosystem": "RubyGems",
"reader": "ruby/gemfilelock",
"packages": 11
}
],
"files_not_read": [],
"unsupported": [],
"unpinned": [],
"conflicts": []
}One package of a real inventory (the rack case of the known incidents corpus), trimmed to one dependency path: more_paths counts the paths left out.
The lists at the end are what makes a run incomplete: a file that could not be read, an ecosystem watchdep does not support, a manifest with no lockfile to pin its versions, and runtimes whose sources disagree. A server shows each one and never treats it as clean.
Every key
A * marks a key that must be present when its parent is.
| Key | Type | What it is |
|---|---|---|
| schema_version * | always "1" | |
| cli_version * | string | |
| taken_at * | string | format date-time |
| taken_by * | one of | "cli", "github" |
| part * | object | |
| root * | string | |
| commit * | string | |
| branch * | string | |
| production_branch * | string | |
| packages * | list of objects | |
| ecosystem * | string | |
| name * | string | |
| version * | string | |
| range * | string | |
| purl * | string | |
| scope * | one of | "production", "development" |
| scope_recorded * | boolean | |
| relation * | one of | "direct", "transitive", "unknown" |
| source_file * | string | |
| paths * | list of lists | |
| paths[] * | list of objects | |
| name * | string | |
| version * | string | |
| more_paths * | integer | at least 0 |
| paths_recorded * | boolean | |
| os_packages * | list of objects | |
| distribution * | string | |
| release * | string | |
| ecosystem * | string | |
| name * | string | |
| version * | string | |
| source_name * | string | |
| source_version * | string | |
| purl * | string | |
| source_file * | string | |
| image * | string | |
| runtimes * | list of objects | |
| kind * | one of | "runtime", "database", "hosting" |
| name * | string | |
| version * | string | |
| source_file * | string | |
| images * | list of objects | |
| reference * | string | |
| read * | boolean | |
| reason * | string | |
| packages * | integer | at least 0 |
| files_read * | list of objects | |
| path * | string | |
| ecosystem * | string | |
| reader * | string | |
| packages * | integer | at least 0 |
| files_not_read * | list of objects | |
| path * | string | |
| reason * | string | |
| unsupported * | list of objects | |
| path * | string | |
| ecosystem * | string | |
| unpinned * | list of objects | |
| path * | string | |
| ecosystem * | string | |
| conflicts * | list of objects | |
| name * | string | |
| runtimes * | list of objects | |
| kind * | one of | "runtime", "database", "hosting" |
| name * | string | |
| version * | string | |
| source_file * | string |