Skip to content

[WIP DRAFT] kanata: Add service support #260237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
bxm156 wants to merge 1 commit into
base: main
Choose a base branch
from
+29 −0
Draft

[WIP DRAFT] kanata: Add service support #260237

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions Formula/k/kanata.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,35 @@ def install
system "cargo", "install", *std_cargo_args
end

def caveats
<<~EOS
Post Install Instructions:
Please see instructions for MacOS at https://github.com/jtroo/kanata/releases

1. Karabiner Driver
This formula requires a specific version of the Karabiner driver to be installed.

2. Permissions:
This formula requires Accessibility and Input Monitoring permissions to function correctly.
After installing, please grant these permissions in System Settings.

Drag and drop the kanata binary: #{opt_bin}/kanata
-> Into System Settings -> Privacy & Security -> Accessibility
and
-> System Settings -> Privacy & Security -> Input Monitoring
EOS
end
Comment on lines +24 to +41
Copy link
Member

@daeho-ro daeho-ro Dec 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part isn't homebrew specific, so it should be upstream manual or else and remove from caveats.


service do
require_root true
Copy link
Member

@daeho-ro daeho-ro Dec 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

During our test, there is no sudo privilege, is this required for sure?

run [opt_bin/"kanata", "--no-wait"]
keep_alive successful_exit: true
environment_variables PATH: std_service_path_env
error_log_path var/"log/kanata.log"
log_path var/"log/kanata.log"
working_dir Dir.home
end

test do
(testpath/"kanata.kbd").write <<~LISP
(defsrc
Expand Down
Loading