https://github.com/zhengqbbb/resvg-js-cli
A high-performance SVG renderer CLI, powered by resvg-js
https://github.com/zhengqbbb/resvg-js-cli
nodejs resvg resvg-js rust svg
Last synced: 29 days ago
JSON representation
A high-performance SVG renderer CLI, powered by resvg-js
- Host: GitHub
- URL: https://github.com/zhengqbbb/resvg-js-cli
- Owner: Zhengqbbb
- License: mpl-2.0
- Created: 2024-07-22T13:31:45.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-02T12:15:49.000Z (about 1 year ago)
- Last Synced: 2025-09-06T14:51:16.721Z (about 1 month ago)
- Topics: nodejs, resvg, resvg-js, rust, svg
- Language: TypeScript
- Homepage:
- Size: 95.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
@resvg/resvg-js-cli
CLI entry for the @resvg/resvg-js package.
A high-performance SVG renderer CLI, powered by resvg-js.
> [resvg-js](https://github.com/yisibl/resvg-js): a high-performance SVG renderer and toolkit, powered by Rust based [resvg](https://github.com/RazrFalcon/resvg/), with Node.js backend using [napi-rs](https://github.com/napi-rs/napi-rs), also a pure WebAssembly backend.
## Installation
### Try It Now
```sh
curl https://cdn.jsdelivr.net/gh/yisibl/resvg-js@v2.6.2/example/text.svg | \
npx @resvg/resvg-js-cli --background "#fff" - output.png
```
### Direct Use
```sh
npx @resvg/resvg-js-cli --help
# or
bunx @resvg/resvg-js-cli --help
```
### Global Install
```sh
npm install -g @resvg/resvg-js-cli
resvg-js --help
```
## Usage
```sh
$ npx @resvg/resvg-js-cli --help
NAME:
resvg-js - A high-performance SVG renderer CLI, powered by resvg-js and Rust based resvg and napi-rs
WEBSITE:
https://github.com/Zhengqbbb/resvg-js-cli
https://github.com/yisibl/resvg-js
SYNOPSIS:
resvg-js [OPTIONS] [output_path] # If empty output_path. The raw data of image to stdout
resvg-js [OPTIONS] - [output_path] # Receives svg string from stdin
OPTIONS:
Font:
--no-system-font Unuse system font, it will be faster
--font-file Local font file path [Mutilple]
--font-dir Local font directories [Mutilple]
--font-default-size Default font size [Default: 12]
--font-default-family The default font family
--font-serif-family The serif font family
--font-sans-serif-family The sans-serif font family
--font-cursive-family The cursive font family
--font-fantasy-family The fantasy font family
--font-monospace-family The monospace font family
Rendering Optimize:
--shape-rendering <0|1|2> Shape rendering optimize rule
[0: optimizeSpeed, 1: crispEdges, 2: geometricPrecision]
--text-rendering <0|1|2> Text rendering optimize rule
[0: optimizeSpeed, 1: optimizeLegibility, 2: geometricPrecision]
--image-rendering <0|1> Image rendering optimize rule
[0: optimizeQuality, 1: optimizeSpeed]
Fit To (default use original):
--fit-width Use fit to width mode
--fit-height Use fit to height mode
--fit-zoom Use fit to zoom mode
Crop:
--crop-top Crop image top size
--crop-left Crop image left size
--crop-right Crop image right size
--crop-bottom Crop image bottom size
--dpi Dots Per Inch
--language Language code [Mutilple]
--background Background color
--log-level Setting log level
[level: "off" | "error" | "warn" | "info" | "debug" | "trace"]
ARGS:
SVG file path. Use "-" for stdin
[output_file_path] Output image file path
EXAMPLES:
$ resvg-js input.svg output.png
$ resvg-js --fit-width 1200 input.svg output.png
$ resvg-js \
--no-system-font \
--font-file "./Font-Light.ttf" \
--font-file "./Font-Bold.ttf" \
--font-default-family "Font" \
--background "rgba(238,235,230,.9)" \
./input.svg ./output.png
$ cat a.svg | resvg-js --fit-width 1200 --image-rending 0 - output.png
```
## Related Links
- [@resvg/resvg-js](https://www.npmjs.com/package/@resvg/resvg-js)
- [@resvg/resvg-wasm](https://www.npmjs.com/package/@resvg/resvg-wasm)
- [x-satori](https://www.npmjs.com/package/x-satori)
## Contributing
```sh
pnpm install
pnpm dev # dev mode
pnpm x --help # start up the CLI and development
```
## License
Please use all lowercase `resvg-js` when referencing project names.
[MPLv2.0](https://www.mozilla.org/en-US/MPL/)
Copyright (c) 2024, [Zhengqbbb](https://github.com/Zhengqbbb)
Copyright (c) 2021-present, yisibl(一丝)