NAME
photobear - CLI for Photobear powered image processing
VERSION
version 0.1.2
SYNOPSIS
photobear [options] <command> <url>
DESCRIPTION
This is a command-line interface (CLI) program for Photobear (https://photobear.io), a tool for image processing. It allows you to perform various operations on images using different commands and a provided URL.
You will need an API key to use the program.
CONFIGURATION FILE
The program looks for a configuration file at ~/.config/photobear.ini
, like:
[photobear]
api_key=YOUR_API_KEY
Alternatively you can set the environment variable PHOTOBEAR_API_KEY
to your API key, or use the --api-key option.
COMMANDS
The program supports the following commands:
- background_removal
-
Remove the background from the image specified by the URL.
- vectorization
-
Vectorize the image specified by the URL (output in SVG format).
- super_resolution
-
Enlarge the image specified by the URL.
- compress
-
Compress the image specified by the URL.
OPTIONS
- -o, --outdir
-
Output directory for the processed image. By default, the program saves the image in the current directory.
- --api-key STRING
-
Specify the API key to use for accessing Photobear. This key is required for authentication.
- --config FILE
-
Specify the configuration file to use. By default, the program looks for the configuration file at
~/.config/photobear.ini
. - --verbose
-
Print verbose output during the execution of the program.
- --help
-
Print the help message, which includes a list of commands and their usage.
EXAMPLES
Trace an image:
photobear vectorization https://example.com/image.jpg -o outputdir
REQUIREMENTS
This program works under MacOS and Linux, and requires Perl 5.18 or higher and curl
to be installed.
AUTHOR
Andrea Telatin <proch@cpan.org>
COPYRIGHT AND LICENSE
This software is Copyright (c) 2023 by Andrea Telatin.
This is free software, licensed under:
The MIT (X11) License