# tinypng-cli-chl

**Repository Path**: happychl/tinypng-cli-chl

## Basic Information

- **Project Name**: tinypng-cli-chl
- **Description**: tinypng图片压缩工具
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-12-21
- **Last Updated**: 2024-04-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# `tinypng-cli-chl`

> 基于`tinypng`的`node`版图片压缩工具

## 使用说明

### 安装

```bash
npm install tinypng-cli-chl -g
# OR
yarn global add tinypng-cli-chl
```

### 使用

#### 压缩图片

进入到需要压缩图片的文件夹下，执行命令`tinypng`即可自动开始压缩当前文件夹下的所有图片，包括子文件夹。

压缩过的图片将会被排除，不会重复压缩，以减少消耗`tinypng`的压缩次数。

注意：本工具压缩后的图片将直接覆盖原始图片，不想覆盖的请勿直接使用！！！

```bash
# 查看帮助文档
tinypng -h

# 压缩图片
tinypng
```

#### 添加`Key`

使用该工具需要自行申请`tinypng`的`API Key`。

在官网注册账户后，可以前往[用户中心](https://tinify.com/dashboard/api)页面查看`API Key`，通过下面的命令将`Key`添加到本工具内使用。

目前一个账户每月只能免费压缩500张，所以可以申请多个账户并添加使用。该工具会在使用过程中自动校验`Key`的有效性并进行切换。

```bash
# 查看帮助文档
tinypng key
# OR
tinypng key -h

# 查看key列表
tinypng key -l
# OR
tinypng key --list

# 添加keys
tinypng key -a xxx,xxx
# OR
tinypng key --add xxx,xxx

# 移除keys
tinypng key -r xxx,xxx
# OR
tinypng key --remove xxx,xxx

# 清空keys
tinypng key -c
# OR
tinypng key --clear
```