yaml-lint-cli

A TypeScript CLI tool for linting, formatting, and converting YAML files.

Installation

npm install -g @asdsadw12312dwd2112xz/yaml-lint-cli

Or run locally after building:

npm run build
node dist/index.js --help

Commands

yaml-lint check <files...>

Validate one or more YAML files for syntax errors.

yaml-lint check config.yaml
yaml-lint check *.yaml

yaml-lint format <file> [--write]

Format a YAML file with consistent 2-space indentation.

# Print formatted output
yaml-lint format config.yaml

# Write formatted output back to file
yaml-lint format config.yaml --write

yaml-lint convert <file> --to json

Convert a YAML file to JSON.

yaml-lint convert config.yaml --to json
yaml-lint convert config.yaml --to json > config.json

yaml-lint merge <file1> <file2>

Deep merge two YAML files. Values from file2 win on conflict.

yaml-lint merge base.yaml override.yaml
yaml-lint merge base.yaml override.yaml > merged.yaml

yaml-lint keys <file>

List all keys in a YAML file using dot notation.

yaml-lint keys config.yaml
# Output:
# server
# server.host
# server.port
# database
# database.url

yaml-lint get <file> <path>

Get the value at a dot-notation path.

yaml-lint get config.yaml server.port
# Output: 8080

yaml-lint get config.yaml database
# Output: { "url": "...", "name": "..." }

Parser Coverage

The built-in YAML parser handles ~90% of common use cases:

• Key-value pairs
• Nested objects (indentation-based)
• Arrays (block style with -)
• Strings (bare, single-quoted, double-quoted)
• Numbers (integers and floats)
• Booleans (true/false/yes/no/on/off)
• Null values (null/~/empty)
• Inline comments (# comment)

Not supported: multi-line strings (|/>), anchors/aliases (&/*), tags (!!), flow sequences/mappings on same line.

Building

npm install
npm run build

License

MIT