https://github.com/rootcircle/pixelup
Image Filtering CLI tool
https://github.com/rootcircle/pixelup
filter image-processing rust
Last synced: 8 months ago
JSON representation
Image Filtering CLI tool
- Host: GitHub
- URL: https://github.com/rootcircle/pixelup
- Owner: rootCircle
- License: apache-2.0
- Created: 2023-05-17T08:31:04.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-20T21:43:09.000Z (over 1 year ago)
- Last Synced: 2025-03-24T01:42:48.171Z (about 1 year ago)
- Topics: filter, image-processing, rust
- Language: Rust
- Homepage:
- Size: 23.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🖼️ PixelUp
PixelUp is a Rust-based CLI tool that allows users to apply image filters offline while
ensuring their privacy. With PixelUp, you can apply filters like sepia, grayscale, negative
, blur, reflection, and edge to your images without worrying about any data being stored or
sent over the internet.
## Usage
To use PixelUp, you'll need to have Rust installed on your machine. Once you have Rust
installed, you can clone the project and then install PixelUp by running cargo install pixel_up.
### Options
Here are the available options for PixelUp:
- -i, --src : The path to the source image you want to apply filters to.
- -o, --output : The path where you want to save the filtered image. If not
provided, the filtered image will be saved in the same directory in png format with output.png filename.
- -f, --filter : The filter you want to apply to the image. Possible values are
sepia, grayscale, negative, blur, reflection, and edge.
- -h, --help: Print help.
- -V, --version: Print version.
### Example
Here's an example command to apply the sepia filter to an image:
```
pixel_up -i /path/to/image.jpg -f sepia
```
This will create a new image with the sepia filter applied in the same directory as the
original image.
## Contribution
If you encounter any issues while using PixelUp or have suggestions for improvement, feel
free to submit an issue or pull request on the Github repository.
## License
PixelUp is licensed under the Apache 2.0 License. See the [LICENSE](https://github.com/rootCircle/PixelUp/blob/main/LICENSE) file for more information.