!Logo

!CI
!License
!Crates.io Version
!NPM Version

> svgtidy is a high-performance SVG optimizer written in Rust.

It removes redundant information from SVG files (like comments, metadata, and hidden elements) and creates a minimized, cleaner version without affecting rendering.

Compared to SVGO, svgtidy is fast—up to 100x faster for single icons and 50x faster for complex files.

---

⚡ Features

- Blazing Fast: Built with Rust, xmlparser and rayon.
- Batch Processing: Parallel directory scanning and optimization.
- AST-based: Robust DOM-like mutations.
- Configurable: Toggle plugins, set precision, and precision formatting.
- Cross-Platform: Runs on CLI, Node.js, and in the browser (WASM).

🚀 Installation & Usage

$3

Use svgtidy directly in your JavaScript/TypeScript projects.

``bash
npm install svgtidy
`

Usage:

`javascript
import { optimize } from 'svgtidy';

const svg = '';
const optimized = optimize(svg);
console.log(optimized);
`

$3

Install the binary tool using Rust's cargo:

`bash


Install from crates.io (Recommended)

cargo install svgtidy

Or build from source

git clone https://github.com/honkinglin/svgtidy.git
cd svgtidy
cargo install --path .
`

Usage:

`bash


Optimize a single file

svgtidy input.svg -o output.svg

Optimize a directory (recursive)

svgtidy icons/ -o dist/

Set precision and disable specific plugins

svgtidy input.svg -o output.svg -p 5 --disable removeTitle
`

$3

Install the dedicated Vite plugin:

`bash
npm install vite-plugin-svgtidy
`

Usage (vite.config.js):

`javascript
import svgtidy from 'vite-plugin-svgtidy';

export default {
plugins: [svgtidy()]
}
`

$3

Install the Webpack loader:

`bash
npm install svgtidy-loader
`

Usage (webpack.config.js):

`javascript
module.exports = {
module: {
rules: [
{
test: /\.svg$/,
use: [
{ loader: 'svgtidy-loader' }
]
}
]
}
}
`

⚙️ Configuration (CLI)

`text
Usage: svgtidy [OPTIONS]

Arguments:
Input file or directory

Options:
-o, --output

Output file or directory
-p, --precision Set numeric precision [default: 3]
--enable Enable specific plugins (comma-separated)
--disable Disable specific plugins (comma-separated)
--pretty Pretty print output
-h, --help Print help

`

🔌 Plugins

svgtidy enables these plugins by default to ensure maximum reduction:

| Plugin Name | Description |
| :--- | :--- |
| removeDoctype | Removes declaration. |
| removeXMLProcInst | Removes instructions. |
| removeComments | Removes comments. |
| removeMetadata | Removes elements. |
| removeTitle | Removes