Configuration - tooka-org/tooka GitHub Wiki

Tooka uses a YAML-based configuration file stored in your system’s standard config directory. You can manage it fully via the CLI:

tooka config --help

🖥 CLI Configuration Commands

You can use the following commands to interact with the configuration file:

tooka config --locate   # Show the path to the config file
tooka config --show     # Print the current config content
tooka config --reset    # Reset config to defaults
  • --locate: Outputs the config file location so you can inspect or edit it manually.
  • --show: Displays the current configuration, including log and rules paths.
  • --reset: Restores the config to its default values using either the system defaults or any environment variables you’ve defined.

🔧 What You Can Configure

Field Description
config_version Internal version number used for config migrations
source_folder Default folder that Tooka will scan when sorting files
rules_file Full path to the active rules file (YAML)
logs_folder Where Tooka writes logs and dry-run reports

📁 Default Config File Locations

OS Path
Linux ~/.config/github.tooka-org/tooka/config.yaml
Windows %APPDATA%\github.tooka-org\tooka\config.yaml
macOS ~/Library/Application Support/github.tooka-org/tooka/config.yaml

🛠 Troubleshooting Config Errors

If Tooka throws an error on first launch or during any command, it’s likely related to the configuration file. Here’s what to check:

  1. Missing or invalid config: Tooka attempts to create or validate the config on every run.
  2. Broken paths: Ensure the rules_file, logs_folder, and source_folder paths exist.
  3. Quick fix: Use tooka config --reset to restore a clean state, then customize as needed.

[!TIP] Always verify that all folders and files referenced in the config actually exist to avoid runtime errors.