Usage

Basic CLI commands

Using the help command to list all other arguments

matugen -h

JSON output flag

Not to be confused with --import-json flag, this one outputs the generated JSON.

matugen <other-arguments> --json <FORMAT>

Example:

matugen color hex "#ffbf9b" --json rgb

Changing the mode to dark or light

The default is dark if no mode is provided.

matugen <other-arguments> -m light

matugen <other-arguments> -m dark

Using the smart mode

This will automatically choose whether to use dark/light mode based on the wallpaper lightness.

matugen color hex "#ffbf9b" --mode smart

Changing the scheme type

The default is scheme-tonal-spot if no scheme is provided. Use the --help flag to see all possible values.

matugen <other-arguments> --type scheme-vibrant

Using the smart scheme

This will automatically choose what scheme type to use based on the image.

matugen color hex "#ffbf9b" --type scheme-smart

Generate from a color

Use matugen -h to see all the available formats you can use.

# Dark mode
matugen color hsl <hsl color> -m "dark"
# Light mode
matugen color hex <hex color> -m "light"

Generate from an image

matugen image /path/to/wallpaper/

Importing JSON

You can also automatically import JSON files from the config. See the [config.import_json_files] option.

Order of importing JSON

The order is from first to last imported, the later ones will overwrite data

1. --import-json
2. --import-json-string
3. [config.import_json_files]

Import JSON from file

matugen <other-arguments> --import-json <path>

Example:

matugen color hex "#ffbf9b" --import-json ./example/custom.json

Import JSON from string

matugen <other-arguments> --import-json-string <json string>

Example:

matugen color hex "#ffbf9b" --import-json-string '{ "text3": "Hello from args!"}'