CLI
The PixelBin CLI is a command-line interface tool that you use to transform locally stored images directly from a command shell.
info
To process your images you will need a PixelBin API token. You can find the API token in your settings under Tokens.
Installing PixelBin CLI
- Go to the Tools & APIs page on the PixelBin website.
- Download and install PixelBin CLI based on your OS.
CLI Options
Option | Alias | Description | Default Value |
---|---|---|---|
--version | -V | Output the version number | |
--key | -k | API token | |
--pattern | -t | Input transformation pattern to transform image(s) | |
--input | -i | Input directory path | Current directory |
--output | -o | Output directory ath | Current directory |
--concurrency | -p | Concurrency | 1 |
--industry-type | -t | Industry type. Specify the industry type to choose the fine-tuned model for that particular domain. | general |
--verbose | -v | Display additional details about internal operations during execution. | false |
--help | -h | Shows a help message for this command in the console. |
Applying transformations with PixelBin CLI
You can apply transformations on all the images in one directory and save the transformed images in another.
<PixelBin CLI> -k <API Token> -t <Transformation> -i <Input Directory> -o <Output Directory>
The following video demonstrates how to apply transformations on your images using PixelBin CLI.