Skip to content

config

Manage NeatCLI configuration.

Usage

neatcli config <ACTION>

Actions

init

Create a sample configuration file:

neatcli config init

Creates ~/.neat/config.toml with example rules.

show

Display current configuration:

neatcli config show

Examples

Initialize Config

neatcli config init

Output: 

✓ Created config file: /Users/you/.neat/config.toml

Sample rules:
  • Invoices: *invoice*.pdf → Documents/Invoices/{year}
  • Screenshots: Screenshot*.png → Images/Screenshots/{year}-{month}

Show Config

neatcli config show

Output: 

→ Config: /Users/you/.neat/config.toml

Rules:
────────────────────────────────────────────────────────────
  • Invoices (priority: 10)
    Pattern: *invoice*.pdf
    Dest:    Documents/Invoices/{year}

  • Screenshots (priority: 5)
    Pattern: Screenshot*.png
    Dest:    Images/Screenshots/{year}-{month}

Settings:
────────────────────────────────────────────────────────────
  Include hidden: false
  Follow symlinks: false
  Default mode: by-type

Config Location

Platform Path
macOS ~/.neat/config.toml
Linux ~/.neat/config.toml
Windows %USERPROFILE%\.neat\config.toml

See Also