Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/FaKleiser/blim
Blazing fast image optimisation for blog post images
https://github.com/FaKleiser/blim
Last synced: 2 months ago
JSON representation
Blazing fast image optimisation for blog post images
- Host: GitHub
- URL: https://github.com/FaKleiser/blim
- Owner: FaKleiser
- License: mit
- Created: 2020-06-27T20:04:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T10:15:36.000Z (about 2 years ago)
- Last Synced: 2024-10-20T08:39:51.090Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 1.49 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-blazingly-fast - blim - Blazing fast image optimisation for blog post images (TypeScript)
README
# blim
Blazing fast image optimization for blog post images.
`blim` helps you optimize images from the command line to be used on blogs.
Typically, `blim` is within the context of statically generated pages.
Current features include:
- Resize and shrink images to a target width/height.
- Crop images automagically if the original image has a different aspect ratio than the desired output resolution.
- Compress images to reduce file size. Usually way better than what other tools do.
Table of contents:
* [blim](#blim)
* [Usage](#usage)
* [Commands](#commands)
* [Contributing](#contributing)
* [[Change Log](CHANGELOG.md)](#change-logchangelogmd)
* [[License](LICENSE)](#licenselicense)
# Usage
```sh-session
$ npm install -g blim
$ blim COMMAND
running command...
$ blim (-v|--version|version)
blim/0.0.2 darwin-x64 node-v10.17.0
$ blim --help [COMMAND]
USAGE
$ blim COMMAND
...
```
# Commands
* [`blim help [COMMAND]`](#blim-help-command)
* [`blim optimize [FILE]`](#blim-optimize-file)
## `blim help [COMMAND]`
display help for blim
```
USAGE
$ blim help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.1.0/src/commands/help.ts)_
## `blim optimize [FILE]`
Optimize an image
```
USAGE
$ blim optimize [FILE]
OPTIONS
-f, --fit=cover|contain|fill|inside|outside
How to fit the width and height
-h, --height=height
The target height to resize to
-p, --position=top|right top|right|right bottom|bottom|left bottom|left|left
top|north|northeast|east|southeast|south|southwest|west|northwest|center|entropy|attention
When using a fit of cover or contain, use this flag to adjust where to crop
-w, --width=width
The target width to resize to
```
# Contributing
Open a PR :-)
# [Change Log](CHANGELOG.md)
See all changes made to this project in the [change log](CHANGELOG.md). This project follows [semantic versioning](http://semver.org/).
# [License](LICENSE)
This project is licensed under the terms of the [MIT license](LICENSE).
---
Project created and maintained by [Fabian Keller](https://www.fabian-keller.de).