Getting Started

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:

The website offers:

Note

Don’t see your preferred package manager listed? Feel free to open an issue, and I’ll take a look!

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.

Let’s walk through your first Tooka session:

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.

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.

Run it for real Once you’re confident, remove the --dry-run flag:
```
tooka sort ~/Downloads
```

Explore more commands To see all available commands and options:
```
tooka --help
```

To learn how rules work and how to customize them, continue to: 👉 How Rules Work