oliframe

oliframe is a simple command line tool to add borders to images. It can process a single image or multiple directories at a time.

Installation

For command-line usage

cargo install oliframe

For library usage

While the purpose of this project is to provide a command-line tool, the underlying library can be used in other projects.

cargo add oliframe

Command-Line Usage

# Add a default white border to all images in the current directory
oliframe

# Add a 20% black border to a single image
oliframe -w 20 -c black image.jpg

# Add a 10% white border to all images in a directory
oliframe -w 10 -c white -d images

# Add a default border to all images in a directory and save them with a new suffix
oliframe -s _bordered -d images

Library Usage

The library only exposes one function, add_border, which expects an &image::DynamicImage as input and returns a new image::DynamicImage with the border applied. Loading and saving images is left to the user.

use oliframe::*;

fn main() {
    let img = image::open("image.jpg").unwrap();
    let bordered_img = add_border(&img, BorderWidth::Percent(5), "white", None);
    bordered_img.save("image_bordered.jpg").unwrap();
}

Roadmap / Future Functionality

• Add option (-W, --watch) to watch for changes in a directory and automatically add borders to new images

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT

AI-Assisted Development

This project has been developed with the assistance of AI-powered tools, including ChatGPT and GitHub Copilot. These tools have contributed to various aspects of the code, ranging from generating initial code snippets to offering suggestions for code optimization and bug fixes. While these tools have aided in the development process, the design and implementation of this project is the work of the author.