id       = "organize-tool"
name     = "organize"
homepage = "https://github.com/tfeldmann/organize"
description = "The file management automation tool."
executables   = ["organize"]

[dotfiles]

# The upstream README documents `organize new`, `organize edit`, and
# `organize show --reveal` around the default config.yaml; its current CLI
# prints the resolved path under ~/.config/organize/config.yaml. The issue
# transcript records that exact path from organize 2.4.0.
# https://github.com/tfeldmann/organize
# https://github.com/tfeldmann/organize/issues/374
paths = ["~/.config/organize/config.yaml"]
exclude = []
secret  = []

[commands]
format = 1
label = "Run organize"
description = "Run or simulate organize rules from a config. Simulate first with Simulate. Config editing commands are outside this form."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = false, short_attached = true, short_bundles = false }

[[commands.subcommand]]
path = ["sim"]
label = "Simulate organizing"
description = "Show what would happen without touching files."

[[commands.subcommand.source]]
id = "help"
kind = "help"
url = "https://github.com/tfeldmann/organize"
evidence = """
  sim        Simulate organizing your files.
  <config>                        A config name or path to a config file
  -W --working-dir <dir>          The working directory
  -T --tags <tags>                Tags to run (eg. "initial,release")
  -S --skip-tags <tags>           Tags to skip
"""

[[commands.subcommand.field]]
id = "working_dir"
label = "Working directory"
type = "path"
option = ["--working-dir", "-W"]
path = { kind = "directory", role = "input" }
sources = ["help"]

[[commands.subcommand.field]]
id = "tags"
label = "Tags to run"
description = "Comma-separated, e.g. initial,release."
type = "string"
option = ["--tags", "-T"]
sources = ["help"]

[[commands.subcommand.field]]
id = "skip_tags"
label = "Tags to skip"
type = "string"
option = ["--skip-tags", "-S"]
sources = ["help"]

[[commands.subcommand.field]]
id = "config"
label = "Config name or path"
type = "string"
position = 0
sources = ["help"]

[[commands.subcommand.task]]
id = "sim"
label = "Simulate"
fields = ["config", "working_dir", "tags", "skip_tags"]
required = []

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["config", "working_dir", "tags", "skip_tags"]

[[commands.subcommand]]
path = ["run"]
label = "Organize files"
description = "Apply the rules and actually move, rename or delete files. Simulate first."

[[commands.subcommand.source]]
id = "help"
kind = "help"
url = "https://github.com/tfeldmann/organize"
evidence = """
  run        Organize your files.
  <config>                        A config name or path to a config file
  -W --working-dir <dir>          The working directory
  -T --tags <tags>                Tags to run (eg. "initial,release")
  -S --skip-tags <tags>           Tags to skip
"""

[[commands.subcommand.field]]
id = "working_dir"
label = "Working directory"
type = "path"
option = ["--working-dir", "-W"]
path = { kind = "directory", role = "input" }
effect = "overwrite"
sources = ["help"]

[[commands.subcommand.field]]
id = "tags"
label = "Tags to run"
type = "string"
option = ["--tags", "-T"]
sources = ["help"]

[[commands.subcommand.field]]
id = "skip_tags"
label = "Tags to skip"
type = "string"
option = ["--skip-tags", "-S"]
sources = ["help"]

[[commands.subcommand.field]]
id = "config"
label = "Config name or path"
type = "string"
position = 0
sources = ["help"]

[[commands.subcommand.task]]
id = "run"
label = "Run"
fields = ["config", "working_dir", "tags", "skip_tags"]
required = []

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["config", "working_dir", "tags", "skip_tags"]