YAMLCheck
A real YAML validator and toolkit. Check syntax, convert YAML to JSON, lint for style issues, and list top-level keys. Uses PyYAML when available, falls back to basic parsing when not.
Commands
| Command | Description |
|---|
| INLINECODE0 | Validate YAML syntax — reports document count, types, key counts, file size. Falls back to basic tab/colon checks without PyYAML |
| INLINECODE1 |
Convert YAML to formatted JSON output. Handles multi-document YAML files |
|
yamlcheck lint <file> | Check for common style issues: tabs, trailing whitespace, Windows line endings, odd indentation, missing spaces after colons, long lines |
|
yamlcheck keys <file> | List top-level keys with types and value previews |
Requirements
- -
python3 (required) - INLINECODE5 (optional — enables full parsing; install with
pip3 install pyyaml)
Without PyYAML, the tool still works but uses basic regex-based checks instead of full YAML parsing.
Examples
CODEBLOCK0
YAMLCheck
一个真正的YAML验证器和工具包。检查语法、将YAML转换为JSON、检查样式问题以及列出顶级键。可用时使用PyYAML,不可用时回退到基础解析。
命令
| 命令 | 描述 |
|---|
| yamlcheck validate <文件> | 验证YAML语法——报告文档数量、类型、键数量、文件大小。没有PyYAML时回退到基础的制表符/冒号检查 |
| yamlcheck to-json <文件> |
将YAML转换为格式化的JSON输出。处理多文档YAML文件 |
| yamlcheck lint <文件> | 检查常见样式问题:制表符、尾随空格、Windows换行符、奇怪的缩进、冒号后缺少空格、长行 |
| yamlcheck keys <文件> | 列出带有类型和值预览的顶级键 |
要求
- - python3(必需)
- PyYAML(可选——启用完整解析;使用pip3 install pyyaml安装)
没有PyYAML时,该工具仍然可以工作,但使用基于正则表达式的基本检查而不是完整的YAML解析。
示例
bash
验证docker-compose文件
yamlcheck validate docker-compose.yml
将YAML配置转换为JSON
yamlcheck to-json values.yaml
检查样式问题
yamlcheck lint playbook.yml
查看定义了哪些键
yamlcheck keys config.yaml