convert-svg-core-cli
v0.7.1
Published
Supports converting SVG into another format using headless Chromium via CLI
Maintainers
Readme
convert-svg-core-cli
The core Node.js package for converting SVG into other formats using headless Chromium that contains the shared logic for all converters to support use as a tool via CLI. This package is not intended to be used directly to convert SVGs and, instead, provides core support for SVG conversion.
Install
If you are looking to install an out-of-the-box SVG converter, check out our converter packages below:
https://github.com/neocotic/convert-svg
Alternatively, if you know what you're doing, you can install using npm:
npm install --save convert-svg-core-cliYou'll need to have at least Node.js v22 or newer.
If you're looking to create a converter for a new format, we'd urge you to consider contributing to this framework so that it can be easily integrated and maintained. Read the Contributors section for information on how you can contribute.
Implementation
To create a new SVG converter that uses convert-svg-core-cli, you'll need to create a new subdirectory for your
package under the packages directory. Try to follow the
convert-svg-to-<FORMAT>-cli naming convention for the converter package name.
Take a look at the other packages in this directory to set up the new package directory. They are all very similar, by design, as you should just need to provide the minimal amount of information required to support your intended output format.
Since this package uses puppeteer, a Chromium instance will download and install a headless Chromium instance.
Testing
There are currently no testing utilities for CLI packages but this should hopefully improve in the future to provide better test coverage of the unified CLI.
Bugs
If you have any problems with this package or would like to see changes currently in development, you can do so here.
Contributors
If you want to contribute, you're a legend! Information on how you can do so can be found in CONTRIBUTING.md. We want your suggestions and pull requests!
A list of all contributors can be found in AUTHORS.md.
License
Copyright © 2025 neocotic
See LICENSE.md for more information on our MIT license.
