Skip to content

Unofficial CLI application that interacts with the Dehancer Online API to process images using various film presets.

License

Notifications You must be signed in to change notification settings

sharovd/Dehancer-CLI

Repository files navigation

Ruff Test Coverage Vulnerabilities status

Dehancer CLI

Overview

Dehancer CLI is an unofficial command line application that interacts with the Dehancer Online API to process images using various film presets.
It allows you to view available presets, create contacts for an image, and develop images using specific film presets and settings.

Features

  • Print presets: Displays a list of the presets available in the Dehancer Online.
  • Create contacts: Uploads an image and creates contacts using all available presets.
  • Develop image(s): Processes image(s) using specified film preset, quality and custom settings.

Usage

Setup the executable file

  • Linux: There are no additional steps required.
  • MacOS: Run $ xattr -d com.apple.quarantine dehancer-cli to remove the quarantine attribute from the specified file. You can find out more about this here or here.
  • Windows: Unfortunately, there is no stable and free solution for running build for Windows to bypass antivirus. See this page for more details.
    You can disable the Microsoft Defender Antivirus service the first time you start the application.

Authentication in Dehancer Online

Authentication is only required for develop image(s) without a watermark.
All of the commands can be used without authentication as well.

$ dehancer-cli auth <[email protected]>

Print list of available presets

$ dehancer-cli presets

Create contacts for an image

$ dehancer-cli contacts <path/to/image.jpg>

Develop image(s)

$ dehancer-cli develop <path/to/image_or_directory> --preset <preset_number> [OPTIONS]

Options

--preset, -p: Preset number (required).

--quality, -q: Image quality level: ["low", "medium", "high"] ("low" by default).

--set_exposure, -e: Exposure setting (adjustments).
--set_contrast, -c: Contrast setting (adjustments).
--set_temperature, -t: Temperature setting (adjustments).
--set_tint, -i: Tint setting (adjustments).
--set_color_boost, -cb: Color boost setting (adjustments).

--set_grain, -g: Grain setting (effects).
--set_bloom, -b: Bloom setting (effects).
--set_halation, -h: Halation setting (effects).
--set_vignette_exposure, -v_e: Vignette exposure setting (effects).
--set_vignette_size, -v_s: Vignette size setting (effects).
--set_vignette_feather, -v_f: Vignette feather setting (effects).

--settings_file: Path to a settings file containing key-value pairs for settings.

--logs: Enable debug logs (1 for enabled, 0 for disabled) (0 by default).

Image Quality Levels

Quality Level Description Resolution Format & Quality
Low Optimised for web Resized to 2160x2160 JPEG 80%
Medium Best quality Max resolution 3024x3024 JPEG 100%
High Lossless Max resolution 3024x3024 TIFF 16 bit

Preset Settings

Note that there are no limits to the values you can specify for settings.
This means that you can specify any floating point number as a value.
The following limits are respected by the Dehancer Online team:

Setting Group Default value Minimum value Maximum value Step
Exposure Adjustments 0 -2 2 0.2
Contrast Adjustments 0 -40 40 2
Temperature Adjustments 0 -90 90 2
Tint Adjustments 0 -90 90 2
Color boost Adjustments 0 -90 90 2
Grain Effects × 0 100 2
Bloom Effects × 0 100 2
Halation Effects × 0 100 2
Vignette exposure Effects × -2 2 0.2
Vignette size Effects 55 5 99 2
Vignette feather Effects 15 4 40 2

× - means that the default value of the effect depends on the selected profile.
All settings in the 'Effects' group support the 'Off' value, which is the default value from the profile.

Clear application cache data

$ dehancer-cli clear-cache

Copy web extension code to clipboard

$ dehancer-cli web-ext

Print application version

$ dehancer-cli --version

Web extension

The web extension is a JavaScript snippet code that can be executed in the browser console to get the current image settings from the Dehancer Online web application.
After executing the $ dehancer-cli web-ext command, the JavaScript snippet code will be copied to computer's clipboard and can be executed in the browser's console.
The following is an example of how the web extension works in the Google Chrome browser, but it should work in other browsers as well.

1. Open the browser console

  • Linux: Press Ctrl + Shift + J
  • MacOS: Press Command (⌘) + Option (⌥) + J
  • Windows: Press Ctrl + Shift + J

2. Paste JavaScript snippet code

screenshot

3. Press Enter to execute code

screenshot

After executing the script, the browser console will display the current image settings for use in the Dehancer CLI.
Both options are available: using the settings.yaml file, or using command line arguments.

Developer mode

It is also possible to use Dehancer CLI without executable files, directly from the source code.
See the README DEV file for more details.

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

Unofficial CLI application that interacts with the Dehancer Online API to process images using various film presets.

Resources

License

Stars

Watchers

Forks