|
-h or --help
Get information about application keys by running the idrembg command with the -h or --help key.
Example:
or
Running such a command line will cause the application to display key information on the console.
The table below provides a description of each key along with an example input.
.\1in – folder containing source files
.\2out – folder for saving processed files
-h or --help – displays information about available keys
Example:
or
|
-i or --in-file <path to source file> – processes a single file (image) and saves it in the folder where the source file is located if the -o key is not specified.
Example:
>idrembg -i D:\1in\001.jpg"
|
or
>idrembg --in-file "D:\1in\001.jpg"
|
– processes the 001.jpg file and saves it to the D:\1in folder named 001.idrembg.jpg. The default background color is light grey.
|
-o or ––out-file <path to processed file> – specifies the location, name and format of the processed file
Example:
>idrembg -i "D:\1in\001.jpg" -o "D:\2out\001.png"
|
or
>idrembg --in-file "D:\1in\001.jpg" --out-file "D:\2out\001.png"
|
– processes the file 001.jpg and saves it to the folder D:\2out in PNG format with the name 001.png. The background color is set to light grey by default.
|
--in-dir <path to folder> – processes in the specified folder all graphic files with extensions: jpg, jpeg, png, webp, bmp, tif, tiff. If the --out-dir key is absent, it saves the processed files to the folder where the original files are located.
Example:
>idrembg --in-dir "D:\1in"
|
– processes graphic files in the D:\1in folder and saves them to the same folder
For example, the D:\1in folder contains files 001.jpg, 002.jpg and 003.jpg. After the command is executed, the original files will be saved in the D:\1in folder and the files 001.idrembg.jpg, 002.idrembg.jpg, 003.idrembg.jpg will be created.
The background color is set to light grey by default.
|
--out-dir <path to folder> – saves the processed files to the specified folder
Example:
>idrembg --in-dir "D:\1in" --out-dir "D:\2out"
|
– processes all graphic files with extensions: jpg, jpeg, png, webp, bmp, tif, tiff in the D:\1in folder. The processed files are saved to the D:\2out folder. For example, the D:\1in folder contains files 001.jpg, 002.jpg and 003.jpg. When the command is executed, the original files will be saved in the D:\1in folder, and the files 001.jpg, 002.jpg, 003.jpg will be created in the D:\2out folder.
The background color is set to light grey by default.
|
-b or ––background <color> – sets the background color
Example:
>idrembg -i "D:\1in\001.jpg" --background rgb(208,227,239)
|
– processes the 001.jpg file, saves it to the D:\1in folder named 001.idrembg.jpg and sets the processed image to a light blue background color (rgb(208,227,239)).
|
--overwrite – overwrites the processed file if it already exists. Files with the .idrembg suffix are always overwritten.
Example:
>idrembg -i "D:\1in\001.jpg" -o "D:\2out\001.jpg" --overwrite
|
– processes the file 001.jpg, saves it to the folder D:\2out named 001.jpg and overwrites it if the file D:\2out\001.jpg already exists.
|
--jpeg-quality <value> – sets the degree of compression (compression) of the processed image (only for JPEG files). The smaller the value in the key, the lower the quality of the image and the smaller its file size.
Example for the file:
>idrembg -i "D:\1in\001.jpg" --jpeg-quality 80
|
– processes file 001.jpg, saves it to the folder D:\1in with the name 001.idrembg.jpg. The processed file 001.idrembg.jpg will be created with a compression ratio of 80, i.e. its quality will be lower and its file size will be smaller than the original 001.jpg.
Example for the folder:
>idrembg --in-dir "D:\1in" --jpeg-quality 80
|
– processes all files in the folder D:\1in, saves them to the same folder with names containing the suffix .idrembg (for example: 001.idrembg.jpg). The processed files will be created with compression level 80, i.e. their quality will be worse and the file size will be smaller than the original files.
|
--output-format <format> – sets the format of processed files. Possible values: jpg, jpeg, png, webp, bmp, tif, tiff.
Example:
>idrembg --in-dir "D:\1in" --out-dir "D:\2out" --output-format png
|
– processes all files in the D:\1in folder and saves them to the D:\2out folder in PNG format
|
--show-system-info – displays system information
Example:
>idrembg --show-system-info
|
As a result of executing the command, the console will display system information about the application, including the serial number (if the application is activated).
|
To run the idrembg command, it is mandatory to set only the keys containing the path to the source file or folder: -i (--in-file) or --in-dir. You can also use these keys together, as shown in the example below. In this case, both the file and the folder will be processed.
Example:
Process file 001.jpg in folder D:\1in and all files in folder D:\3in.
>idrembg -i "D:\1in\001.jpg" --in-dir "D:\3in"
|
This command line will create a processed file D:\1in\001.jpg next to the source file D:\1in\001.idrembg.jpg, and will create processed files (e.g. 001.jpg, 002.jpg and 003.jpg) next to the source files (e.g. 001.idrembg.jpg, 002.idrembg.jpg and 003.idrembg.jpg) in the D:\3in folder.
Other keys can be configured according to your preferences.
|