Getting Started - tooka-org/tooka GitHub Wiki

Tooka is designed to be simple, fast, and cross-platform โ€” it runs on macOS, Windows, and Linux with no setup hassle.


๐Ÿ“ฅ Installation

You can download the appropriate Tooka binary from the official website:

๐Ÿ‘‰ https://tooka.deno.dev/download

The website offers:

  • Direct downloads of prebuilt binaries (built via GitHub Actions)
  • A list of officially supported package managers

[!NOTE] Donโ€™t see your preferred package manager listed? Feel free to open an issue, and Iโ€™ll take a look!


๐Ÿš€ First Run

After installation, verify that Tooka is installed correctly:

tooka --version

This command also initializes the default config if it's not already set up. You should see the latest version printed to the terminal.


โœจ Your First Rule

Letโ€™s walk through your first Tooka session:

  1. Create a new rule Use the online rule builder or generate a template using the CLI:

    tooka template --help
    

[!TIP] Use --help with any command to understand what it does before running it.


  1. Dry-run your rule Test your setup without making any changes:

    tooka sort --dry-run ~/Downloads
    

[!WARNING] Always start with a dry-run! Tooka cannot undo actions. Be safe and preview changes first.


  1. Run it for real Once youโ€™re confident, remove the --dry-run flag:

    tooka sort ~/Downloads
    

  1. Explore more commands To see all available commands and options:

    tooka --help
    

๐Ÿ“˜ Learn More

To learn how rules work and how to customize them, continue to: ๐Ÿ‘‰ How Rules Work