@overworks/chara-card-cli
v0.2.0
Published
CLI for Character Card validation, normalization, and inspection
Readme
@overworks/chara-card-cli
Command-line interface for Character Card validation, normalization, and conversion.
Features
- Validation: Check validity of JSON, PNG, or CharX files.
- Normalization: Convert cards to the latest spec and output as pretty JSON.
- Inspection: View summary metadata (name, creator, tags, assets, etc.).
- Metadata Handling: Extract or embed JSON data directly into PNG files.
- Container Management: Pack directories into
.charxor unpack.charxto directories. - Conversion: Universal converter between JSON, PNG, and CharX formats.
Installation
# Global installation
npm install -g @overworks/chara-card-cli
# Or run instantly via npx
npx @overworks/chara-card-cli --helpCommands
validate <file>: Validate a card file.normalize <file>: Normalize and print JSON.inspect <file>: Show summary info.extract <png-file>: Extract JSON from PNG.embed <json-file> <png-file>: Embed JSON into PNG.pack <dir> [output]: Create a CharX container.unpack <charx> <dir>: Extract a CharX container.convert <input> --to <format>: Convert between formats (json, png, charx).
License
MIT
