Configuration#

Editing the configuration#

organize has a default config file if no other file is given.

To edit the default configuration file:

organize edit  # opens in $EDITOR
organize edit --editor=vim
EDITOR=code organize edit

To open the folder containing the configuration file:

organize reveal
organize reveal --path  # show the full path to the default config

To check your configuration run:

organize check
organize check --debug  # check with debug output

To run / simulate the default config file:

organize sim
organize run

To run / simulate a specific config file:

organize sim [FILE]
organize run [FILE]

Optionally you can specify the working directory like this:

organize sim [FILE] --working-dir=~/Documents

You can tag your rules like this:

rules:
  - name: My first rule
    actions:
      - echo: "Hello world"
    tags:
      - debug
      - fast

Then use the command line options --tags and --skip-tags so select the rules you want to run. The options take a comma-separated list of tags:

organize sim --tags=debug,foo --skip-tags=slow

Special tags:

Rules tagged with the special tag always will always run (except if --skip-tags=always is specified)
Rules tagged with the special tag never will never run (except if ' --tags=never is specified)

ORGANIZE_CONFIG - The path to the default config file.
ORGANIZE_EXIFTOOL_PATH - Path to the exiftool executable (Default: "")
ORGANIZE_NORMALIZE_UNICODE - Whether to normalize strings to NFC unicode form for comparisons (Default "1")
NO_COLOR - if this is set, the output is not colored.
EDITOR - The editor used to edit the config file.

To speed up organizing you can run multiple organize processes simultaneously like this (linux / macOS):

organize run config_1.yaml & \
organize run config_2.yaml & \
organize run config_3.yaml &

Make sure that the config files are independent from each other, meaning that no rule depends on another rule in another config file.