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:
-
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
๐ Learn More
To learn how rules work and how to customize them, continue to: ๐ How Rules Work