@kwayteow/picopress
v0.1.0
Published
基于tinify的命令行图片压缩工具
Readme
@kwayteow/picopress
基于tinify的命令行图片压缩工具
Usage
$ npm install -g @kwayteow/picopress
$ picopres COMMAND
running command...
$ picopres (--version)
@kwayteow/picopress/0.1.0 linux-x64 node-v22.14.0
$ picopres --help [COMMAND]
USAGE
$ picopres COMMAND
...Commands
picopres compress SOURCEpicopres config [KEY] [VALUE]picopres help [COMMAND]picopres pluginspicopres plugins add PLUGINpicopres plugins:inspect PLUGIN...picopres plugins install PLUGINpicopres plugins link PATHpicopres plugins remove [PLUGIN]picopres plugins resetpicopres plugins uninstall [PLUGIN]picopres plugins unlink [PLUGIN]picopres plugins update
picopres compress SOURCE
使用 TinyPNG API 压缩图片
USAGE
$ picopres compress SOURCE [-k <value>] [-o <value>]
ARGUMENTS
SOURCE 要压缩的图片或图片目录的路径
FLAGS
-k, --key=<value> TinyPNG API 密钥
-o, --output=<value> 输出目录
DESCRIPTION
使用 TinyPNG API 压缩图片
EXAMPLES
$ picopres compress path/to/image.jpg --key YOUR_API_KEY
$ picopres compress path/to/images/folder --key YOUR_API_KEY
$ picopres compress path/to/image.jpg # 使用全局配置的 API 密钥See code: src/commands/compress/index.ts
picopres config [KEY] [VALUE]
管理全局配置,如 API 密钥和语言首选项
USAGE
$ picopres config [KEY] [VALUE]
ARGUMENTS
KEY 配置键名 (apiKey, language 或 debug)
VALUE 配置的值
DESCRIPTION
管理全局配置,如 API 密钥和语言首选项
EXAMPLES
$ picopres config apiKey YOUR_API_KEY
$ picopres config language en-US
$ picopres config debug true
$ picopres config apiKey
$ picopres configSee code: src/commands/config/index.ts
picopres help [COMMAND]
Display help for picopres.
USAGE
$ picopres help [COMMAND...] [-n]
ARGUMENTS
COMMAND... Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for picopres.See code: @oclif/plugin-help
picopres plugins
List installed plugins.
USAGE
$ picopres plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ picopres pluginsSee code: @oclif/plugin-plugins
picopres plugins add PLUGIN
Installs a plugin into picopres.
USAGE
$ picopres plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into picopres.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the PICOPRES_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the PICOPRES_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ picopres plugins add
EXAMPLES
Install a plugin from npm registry.
$ picopres plugins add myplugin
Install a plugin from a github url.
$ picopres plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ picopres plugins add someuser/somepluginpicopres plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ picopres plugins inspect PLUGIN...
ARGUMENTS
PLUGIN... [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ picopres plugins inspect mypluginSee code: @oclif/plugin-plugins
picopres plugins install PLUGIN
Installs a plugin into picopres.
USAGE
$ picopres plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into picopres.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the PICOPRES_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the PICOPRES_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ picopres plugins add
EXAMPLES
Install a plugin from npm registry.
$ picopres plugins install myplugin
Install a plugin from a github url.
$ picopres plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ picopres plugins install someuser/somepluginSee code: @oclif/plugin-plugins
picopres plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ picopres plugins link PATH [-h] [--install] [-v]
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
--[no-]install Install dependencies after linking the plugin.
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ picopres plugins link mypluginSee code: @oclif/plugin-plugins
picopres plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ picopres plugins remove [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ picopres plugins unlink
$ picopres plugins remove
EXAMPLES
$ picopres plugins remove mypluginpicopres plugins reset
Remove all user-installed and linked plugins.
USAGE
$ picopres plugins reset [--hard] [--reinstall]
FLAGS
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
--reinstall Reinstall all plugins after uninstalling.See code: @oclif/plugin-plugins
picopres plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ picopres plugins uninstall [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ picopres plugins unlink
$ picopres plugins remove
EXAMPLES
$ picopres plugins uninstall mypluginSee code: @oclif/plugin-plugins
picopres plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ picopres plugins unlink [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ picopres plugins unlink
$ picopres plugins remove
EXAMPLES
$ picopres plugins unlink mypluginpicopres plugins update
Update installed plugins.
USAGE
$ picopres plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
PicoPress
基于tinify的命令行图片压缩工具。
安装
npm install -g @kwayteow/picopress使用方法
压缩单个图片
picopres compress path/to/image.jpg --key YOUR_API_KEY压缩整个文件夹中的图片
picopres compress path/to/images/folder --key YOUR_API_KEY输出到指定目录
默认情况下,压缩后的图片会覆盖原始文件。如果你想保留原始文件,可以使用 --output 选项指定输出目录:
picopres compress path/to/images/folder --key YOUR_API_KEY --output path/to/output/folder使用环境变量
为了避免每次都输入API密钥,你可以设置环境变量:
export TINIFY_API_KEY=your_api_key
picopres compress path/to/image.jpg使用全局配置
你也可以使用全局配置来存储API密钥和其他设置:
# 设置API密钥
picopres config apiKey YOUR_API_KEY
# 设置语言(支持 zh-CN 和 en-US)
picopres config language zh-CN
# 查看当前配置
picopres config
# 查看特定配置项
picopres config apiKey
# 删除配置项
picopres config apiKey --unset支持的图片格式
- JPEG (.jpg, .jpeg)
- PNG (.png)
- WebP (.webp)
TinyPNG API
PicoPress 使用 TinyPNG API 来压缩图片。你需要在 TinyPNG 开发者页面 注册一个免费账号来获取 API 密钥。免费账号每月可以压缩 500 张图片。
开源协议
MIT
