A powerful CLI tool for optimizing icons in your web projects with focus on performance and simplicity.
A command-line tool for optimizing icons in your web projects. This tool helps reduce icon file sizes and improve loading performance.
- Optimizes SVG, PNG, and other icon formats
- Interactive CLI interface
- Configurable output paths
- Verbose mode for detailed optimization information
- Easy to use with minimal configuration
# Using npm
npm install -g optimize-icons-cli
# Using yarn
yarn global add optimize-icons-cli
# Using pnpm
pnpm add -g optimize-icons-cli
# Basic usage
optimize-icons
# Specify output path
optimize-icons -o dist/browser
# Enable verbose mode
optimize-icons -o dist/browser -v
# Show help
optimize-icons --help
If you run the command without any arguments, it will start in interactive mode:
optimize-icons
The tool will prompt you for:
- Output path (default: dist/browser)
- Icons path (default: dist/browser/icons)
- Verbose mode (yes/no)
Option | Alias | Description |
---|---|---|
--output-path |
-o |
Specify the output dist directory for optimized icons |
--icons-path |
-i |
Specify the icons directory for optimized icons |
--verbose |
-v |
Enable verbose output |
--version |
- | Show version number |
--help |
- | Show help |
You can also use the tool programmatically in your Node.js projects:
import CLI from 'optimize-icons-cli';
const cli = CLI.getInstance();
await cli.run();
The tool accepts the following configuration options:
interface OptimizeIconsOptions {
outputPath: string; // Path where optimized icons will be saved
verbose: boolean; // Enable detailed logging
}
Add additional notes about how to deploy this on a live system.
Made with ❤️ by Kiet Le