Nata Script Options
January 4, 2025 ยท View on GitHub
This document lists all Nata script options in detail.
Table of Contents
-h,--help-v,--version-q,--quiet-R,--rule-i,--interval-p,--port-C,--class-t,--title-l,--layer-c,--config-r,--recipes
-h, --help
| DESC | Display the help message and exit. |
-v, --version
| DESC | Show the script version and exit. |
-q, --quiet
| DESC | Run in quiet mode; logs errors only, without logging informational messages or warnings. |
-R, --rule
| DESC | Displays detailed information about the active window and the matching rule. |
This option can be useful for testing whether the active window matches any rules defined in your configuration.
-i, --interval
| DESC | Set the update interval for checking the active window and changing the layer. |
| ARG | N (in milliseconds)once to specify a single check. |
| Def | 200 |
Note
If the interval is specified in the configuration file as well, the interval option will override it.
If set to once, it will exit after a single check.
Warning
The recommended range for the update interval is 50 to 200 milliseconds. Using value below 50 milliseconds will increase CPU usage.
-p, --port
| DESC | Specify a TCP port or an IP address with a port. |
| ARG | PORT or IP:PORT |
| Def | 127.0.0.1:10000 |
Important
Ensure that the specified IP and port match those used by Kanata to avoid connection issues. For example:
kanata -p 127.0.0.1:10000
-C, --class
| DESC | Change to the layer and exit if the specified argument matches the rule: { "class": "<VALUE>", "title": "*" }. |
| ARG | WINDOW_CLASS |
For more information about rules, see the window rules doc.
-t, --title
| DESC | Change to the layer and exit if the specified argument matches the rule: { "class": "*", "title": "<VALUE>" }. |
| ARG | WINDOW_TITLE |
For more information about rules, see the window rules doc.
-l, --layer
| DESC | Specify a layer name to switch to that layer and exit. |
| ARG | LAYER_NAME |
-c, --config
| DESC | Specify the path to the config file in JSON format. |
| ARG | CONFIG_FILE |
| DEF | ~/.config/kanata/config.json |
For more information and examples, see the config doc.
-r, --recipes
| DESC | Specify the path to a script that will run in the background whenever the layer changes. |
| ARG | SCRIPT_PATH |
| DEF | ~/.config/kanata/recipes.sh |
For more information and examples, see the recipes doc.
If you find something unclear or have suggestions for improvements, we welcome your contributions! Please feel free to report any bugs or issues you encounter.