跳转到内容

CLI 参考

每条命令都接受 -h/--help。本页由同样的输出生成,并对照实际构建出的二进制文件手工保持同步,而不是凭记忆编写。

适用于每一条命令:

--config string path to enodia.yaml (default: search standard locations)
--settings string path to settings.yaml (default: search standard locations; missing is not an error)
collect only gathers facts: an unreachable target is recorded as an
observation with an error, not treated as a command failure. The exit
code reflects whether collection itself ran, not what it found - that
judgement is check's job.
-o, --output string output file, or - for stdout (default "-")
check evaluates the patch, lifecycle and newer-branch axes for every
target as of the moment its data was collected. Without --from it
collects first, in this same process - not a second code path. With
--from it reads an existing inventory and only ever reaches the network
for the lifecycle resolver.
--view selects the table focus: compact (default), lifecycle, drift, or
fleet - the offline-only view of version spread across a product's
instances. When --view is not passed, settings.yaml's render.default_view
applies instead of the compact default, if set.
--fail-on strings escalate an axis value to a hard failure, e.g. --fail-on=patch:behind (repeatable)
--from string read an existing inventory instead of collecting
--view string table view: compact, lifecycle, drift, or fleet (default "compact")
--warn-days int warn this many days before a lifecycle boundary is reached
export writes one self-contained file - nothing here serves it; nginx,
a cron job, or a systemd timer regenerating it is what does.
--format selects json, prometheus, or html. When --format is not passed,
settings.yaml's export.default_format applies instead, if set; the
built-in default stays json either way.
--view restricts an html export to one view (compact, lifecycle, drift,
or fleet) instead of all four stacked sections; ignored by
json/prometheus, which always carry every observation and assessment.
--fail-on strings escalate an axis value to a hard failure (repeatable)
--format string output format: json, prometheus, or html (default "json")
--from string read an existing inventory instead of collecting
-o, --output string output file, or - for stdout (default "-")
--view string html only: restrict the report to one view (compact, lifecycle, drift, fleet); default is all four
--warn-days int warn this many days before a lifecycle boundary is reached

三个子命令,除全局标志外没有自己的标志。

根据当前的搜索顺序,打印实际会使用的配置文件——请参阅配置

resolve tries https, then http (never http first - that would put a
credential on the wire in the clear), for every target whose address
has no explicit scheme. It sends no credentials and does not modify the
config file - it only reports what scheme each target would use.

校验配置文件及其凭据引用——包括目标所声明的 credentials: 名称是否确实解析到探针能够理解的条目,完全离线进行。

列出所有支持的产品——完整表格请参阅支持的产品

history reads every "*.jsonl" file in --dir and evaluates each one
against its own collection time - not today - building one timeline
per target ID. Producing that directory needs no code at all, just
"enodia collect -o \"$(date +%F).jsonl\"" on a schedule. This command is
the other half: reading many of them back as one history.
--dir string directory of dated *.jsonl inventories (required)
--fail-on strings escalate an axis value to a hard failure (repeatable)
--format string output format: table or json (default "table")
-o, --output string output file, or - for stdout (default "-")
--warn-days int warn this many days before a lifecycle boundary is reached
serve collects and evaluates on a timer (--interval) and serves
whatever the last successful cycle produced - a request never triggers
a new collection. There is no built-in authentication or TLS: put this
behind a reverse proxy.
Endpoints: / (HTML, all four views), /report.json, /metrics
(Prometheus), /healthz (liveness only - never touches the snapshot).
--fail-on strings escalate an axis value to a hard failure (repeatable) - reflected in the served report, not a process exit code
--interval duration how often to refresh the snapshot (default 1h0m0s)
--listen string address to listen on (default ":8080")
--warn-days int warn this many days before a lifecycle boundary is reached

打印 enodia 的版本、提交和构建日期。

打印 enodia 的徽标以及构建信息:版本、提交、构建日期、Go 版本、平台、产品(探针)数量、许可证和仓库 URL。

生成 shell 自动补全脚本。请针对您使用的 shell(bash、zsh、fish、powershell)运行 enodia completion --help