shinydir.toml

#----------------------------#
#      General Settings      #
#----------------------------#

[settings]
color = true # color terminal output
use-unicode = true # use fancy symbols in terminal output. If false defaults to ascii text

hide-ok-directories = true # hide directories (and automove rules) when they are all good
                           # if true, it will hide from the output directories that would
                           # otherwise show with a green checkmark (or "OK" in uncolored mode)

#----------------------------#
#         Directories        #
#----------------------------#

[dir."$HOME"]
allowed-dirs = [
    { pattern = "^[A-Z][a-z]*$" }, # allow directories with a capitalized ascii name without whitespaces
    { pattern = "^\\." }, # allow any hidden directory
]
allowed-files = [
    { pattern = "^\\." }, # allow any hidden file
]

[dir."$XDG_VIDEOS_DIR"]
recursive = true # sub-folders will have the same rules
recursive-ignore-children = [
    # while performing recursive check, it will ignore these child directories
    { name = ".gallery" },
    { name = "CacheClip" },
]
# no 'allowed-dirs' means any directory is valid
allowed-files = [
    { ext = "mp4" },
    { ext = "mov" },
    { ext = "mkv" },
    { ext = "webm" },
]

[dir."$XDG_MUSIC_DIR"] # $XDG_MUSIC_DIR will be replaced with the path to the current user's Music directory
recursive = true
allowed-files = [
    { ext = "mp3" },
    { ext = "m4a" },
    { ext = "opus" },
    { ext = "flac" },
]

[dir."$XDG_DOWNLOAD_DIR"]
allowed-dirs = [] # empty 'allowed-dirs' mean no directory is valid
# no 'allow-files' means any file is valid

#----------------------------#
#       Auto Move Rules      #
#----------------------------#

[automove]
script-warning = true # display a warning message if some automove rules are using scripts
                      # as they can slow down the program quite a bit with thousands of matched files
report-info = "count" # display how many files could be
                      # automatically moved at the end of a report
                      # options are: "no", "any", "count"

allow-overwrite = false # leave this false if you're not sure
                        # If true, it will allow overwriting files

force-dry-run = true # force dry run setting
                     # This is a security for new users. Turn it off (= false) to use auto-move!

# [[automove.rules]]
# name = "Home-Videos" # give a name to the rule otherwise it will dispaly the path of `parent`
#                      # since several rules can have the same parent, it's recommended
#                      # to give a name to every rule
# parent = "$HOME"
# match = [
#     { ext = "mp4" },
#     { ext = "mov" },
#     { ext = "mkv" },
# ]
# to = "$XDG_VIDEOS_DIR"

# [[automove.rules]]
# name = "Home-Music"
# parent = "$HOME"
# match = [
#     { ext = "mp3" },
#     { ext = "m4a" },
#     { ext = "opus" },
#     { ext = "flac" },
# ]
# to = "$HOME/Music"

# [[automove.rules]]
# name = "Screenshots"
# parent = "$XDG_PICTURES_DIR/Screenshots"
# match = [
#     { ext = "png" },
#     { ext = "jpg" },
# ]
# to = "XDG_PICTURES_DIR/Screenshots"
# # pass each matched file to the following script that returns placement filename
# # the script path is relative to the parent directory of this config file
# # Note: `to` is still required! It will be the base path of any relative filename the script returns.
# #       However, the script is free to return absolute paths in which case `to` will be ignored
# # WARNING! This can slow down auto-move drastically, use with care! (it will not slow down count check report info count though)
# to-script = "examples/dated-monthly.sh"