https://github.com/zenkiet/optimize-icons-cli
CLI tool for optimizing icons for angular project (only support sprites svg)
https://github.com/zenkiet/optimize-icons-cli
angular angular-tools cli optimize svg-icons tools
Last synced: about 2 months ago
JSON representation
CLI tool for optimizing icons for angular project (only support sprites svg)
- Host: GitHub
- URL: https://github.com/zenkiet/optimize-icons-cli
- Owner: zenkiet
- License: mit
- Created: 2024-11-12T16:35:05.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-12-11T03:07:59.000Z (5 months ago)
- Last Synced: 2025-03-13T17:52:25.783Z (2 months ago)
- Topics: angular, angular-tools, cli, optimize, svg-icons, tools
- Language: TypeScript
- Homepage: https://npmjs.com/package/optimize-icons-cli
- Size: 276 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# optimize-icons-cli
optimize-icons-cli
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.
## Features
- 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
## Installation
```bash
# Using npm
npm install -g optimize-icons-cli
# Using yarn
yarn global add optimize-icons-cli
# Using pnpm
pnpm add -g optimize-icons-cli
```
## Usage
### Command Line
```bash
# Show version
optimize-icons --version
# Show help
optimize-icons --help
```
### Interactive Mode
If you run the command without any arguments, it will start in interactive mode:
```bash
optimize-icons
```
The tool will prompt you for:
- Output path (default: dist/browser)
- Icons path (default: dist/browser/icons)
- Custom name of icons svg file (example: material_outline, material_solid...)
- Icons to ignore (comma-separated)
- Verbose mode (yes/no)
### Options
| Option | Alias | Description |
| ---------------- | ----- | ----------------------------------------------------- |
| `--output-path` | `-o` | Specify the output dist directory for optimized icons |
| `--icons-path` | `-i` | Specify the icons directory for optimized icons |
| `--ignore-files` | `-I` | Specify icons to ignore (comma-separated) |
| `--names` | `-n` | Specify the custom name of icons svg file |
| `--verbose` | `-v` | Enable verbose output |
| `--version` | - | Show version number |
| `--help` | - | Show help |
## Programmatic Usage
You can also use the tool programmatically in your Node.js projects:
```typescript
import CLI from 'optimize-icons-cli';
const cli = CLI.getInstance();
await cli.run();
```
## Configuration
The tool accepts the following configuration options:
```typescript
interface OptimizeIconsOptions {
outputPath: string; // Path where optimized icons will be saved
iconsPath: string; // Path where original icons are located
names: string; // Custom name of icons svg file (comma-separated)
ignoreFiles: string; // Icons path to ignore (comma-separated)
verbose: boolean; // Enable detailed logging
}
```
## 💫 Deployment
Add additional notes about how to deploy this on a live system.
---
Made with ❤️ by Kiet Le