completion - missing workbrew support

[ondrish]

when running "jamf-cli completion install":

Detected shell: zsh
{
"error": "general",
"exitCode": 1,
"message": "writing completion file: open /opt/homebrew/share/zsh/site-functions/_jamf-cli: permission denied"
}

but if user has workbrew installed instead of homebrew:
which brew
/opt/workbrew/bin/brew

[neilmartin83]

Hi @ondrish ,

Couple of questions - where you encounter this error:

1. Does the user have both Homebrew and Workbrew installed?
2. What does a Workbrew user get if they run the command brew --prefix?

jamf-cli determines the brew's actual location by running that command, in order to install shell completion to it.

Regarding the permission denied error, that means the user running jamf-cli can't write to that location. Could this be a shared computer (another user installed brew?) or org policy locking it down?

[ondrish]

Hi @neilmartin83,

Great questions, I have only workbrew installed, but I see the problem now:
brew --prefix returns "/opt/homebrew" while "which brew" returns "/opt/workbrew/bin/brew" which is interesting. I did some digging, and on my machine (where only workbrew was installed, at least I think) I see following, hope this helps:

% ls -la /opt
total 0
drwxr-xr-x 5 root wheel 160 Apr 2 16:13 .
drwxr-xr-x 22 root wheel 704 Apr 6 10:10 ..
drwxr-xr-x 3 root wheel 96 Apr 21 10:32 ManagedFrameworks
drwxr-xr-x+ 38 workbrew workbrew 1216 Apr 21 14:00 homebrew
drwxr-xr-x 8 root wheel 256 Apr 2 16:16 workbrew

% ls -la /opt/homebrew
total 136
drwxr-xr-x+ 38 workbrew workbrew 1216 Apr 21 14:00 .
drwxr-xr-x 5 root wheel 160 Apr 2 16:13 ..
drwxr-xr-x+ 3 workbrew workbrew 96 Apr 2 07:53 .claude
drwxr-xr-x+ 3 workbrew workbrew 96 Apr 2 07:53 .cursor
drwxr-xr-x+ 4 workbrew workbrew 128 Apr 2 07:53 .devcontainer
-rw-r--r--+ 1 workbrew workbrew 51 Apr 2 07:53 .dockerignore
-rw-r--r--+ 1 workbrew workbrew 380 Apr 2 07:53 .editorconfig
drwxr-xr-x+ 14 workbrew workbrew 448 Apr 21 14:00 .git
drwxr-xr-x+ 13 workbrew workbrew 416 Apr 21 14:00 .github
-rw-r--r--@ 1 workbrew workbrew 6932 Apr 14 10:36 .gitignore
-rw-r--r--+ 1 workbrew workbrew 1342 Apr 2 07:53 .shellcheckrc
drwxr-xr-x+ 3 workbrew workbrew 96 Apr 2 07:53 .sublime
-rw-r--r--+ 1 workbrew workbrew 89 Apr 2 07:53 .vale.ini
drwxr-xr-x+ 7 workbrew workbrew 224 Apr 7 08:40 .vscode
-rw-r--r--+ 1 workbrew workbrew 3900 Apr 2 07:53 AGENTS.md
-rw-r--r--+ 1 workbrew workbrew 207 Apr 2 07:53 CHANGELOG.md
-rw-r--r--+ 1 workbrew workbrew 11 Apr 2 07:53 CLAUDE.md
-rw-r--r--+ 1 workbrew workbrew 669 Apr 2 07:53 CODEOWNERS
-rw-r--r--@ 1 workbrew workbrew 2435 Apr 21 14:00 CONTRIBUTING.md
drwxrwxr-x 5 workbrew workbrew 160 Apr 16 10:04 Caskroom
drwxrwxr-x 12 workbrew workbrew 384 Apr 21 14:01 Cellar
-rw-r--r--+ 1 workbrew workbrew 4198 Apr 2 07:53 Dockerfile
drwxrwxr-x 2 workbrew workbrew 64 Apr 2 07:50 Frameworks
-rw-r--r--+ 1 workbrew workbrew 1334 Apr 2 07:53 LICENSE.txt
drwxr-xr-x+ 6 workbrew workbrew 192 Apr 21 14:00 Library
-rw-r--r--+ 1 workbrew workbrew 8251 Apr 2 07:53 README.md
drwxrwxr-x+ 11 workbrew workbrew 352 Apr 21 14:01 bin
drwxr-xr-x+ 7 workbrew workbrew 224 Apr 14 10:36 completions
drwxr-xr-x+ 88 workbrew workbrew 2816 Apr 21 14:00 docs
drwxrwxr-x 6 workbrew workbrew 192 Apr 14 10:48 etc
drwxrwxr-x 9 workbrew workbrew 288 Apr 14 10:48 include
drwxrwxr-x 22 workbrew workbrew 704 Apr 14 10:48 lib
drwxr-xr-x+ 4 workbrew workbrew 128 Apr 21 14:00 manpages
drwxrwxr-x 15 workbrew workbrew 480 Apr 21 14:01 opt
drwxr-xr-x+ 5 workbrew workbrew 160 Apr 2 07:53 package
drwxrwxr-x 2 workbrew workbrew 64 Apr 2 07:50 sbin
drwxrwxr-x 10 workbrew workbrew 320 Apr 14 10:48 share
drwxrwxr-x 3 workbrew workbrew 96 Apr 2 07:50 var

% ls -la /opt/workbrew
total 0
drwxr-xr-x 8 root wheel 256 Apr 2 16:16 .
drwxr-xr-x 5 root wheel 160 Apr 2 16:13 ..
drwxr-xr-x 3 root wheel 96 Mar 31 18:50 bin
drwxr-xr-x 3 root wheel 96 Apr 2 16:16 etc
drwxr-xr-x 4 workbrew workbrew 128 Apr 2 16:16 home
drwxr-xr-x 4 root wheel 128 Mar 31 18:50 libexec
drwxr-xr-x 4 root wheel 128 Mar 31 18:50 sbin
drwxr-xr-x 5 workbrew workbrew 160 Apr 21 14:01 var

after checking workbrew install PKG, I see that all it installs goes to /opt/workbrew/ , but the workbrew installer actually bundles homebrew installer as well, I think it is called sometime later in the Workbrew install process, but from a quick look into pre and postinstall scripts I cant see when/where. This would need investigating further.

[ondrish]

also one more ting i forgot to attach:

% ls -la /opt/homebrew/share/zsh/
total 0
drwxr-xr-x 3 workbrew workbrew 96 Apr 2 07:50 .
drwxrwxr-x 10 workbrew workbrew 320 Apr 14 10:48 ..
drwxr-xr-x 7 workbrew workbrew 224 Apr 21 14:01 site-functions

% ls -la /opt/homebrew/share/zsh/site-functions
total 0
drwxr-xr-x 7 workbrew workbrew 224 Apr 21 14:01 .
drwxr-xr-x 3 workbrew workbrew 96 Apr 2 07:50 ..
lrwxr-xr-x 1 workbrew workbrew 30 Apr 2 07:54 _brew -> ../../../completions/zsh/_brew
lrwxr-xr-x@ 1 workbrew workbrew 56 Apr 14 10:48 _eza -> ../../../Cellar/eza/0.23.4/share/zsh/site-functions/_eza
lrwxr-xr-x 1 workbrew workbrew 72 Apr 2 07:56 _ghostty -> /Applications/Ghostty.app/Contents/Resources/zsh/site-functions/_ghostty
lrwxr-xr-x@ 1 workbrew workbrew 66 Apr 21 14:01 _jamf-cli -> ../../../Cellar/jamf-cli/1.12.0/share/zsh/site-functions/_jamf-cli
lrwxr-xr-x@ 1 workbrew workbrew 61 Apr 14 10:36 _zoxide -> ../../../Cellar/zoxide/0.9.9/share/zsh/site-functions/_zoxide

[neilmartin83]

That's all very revealing, thank you.

So - when brew (Home or Work flavour) installs jamf-cli, it will handle the shell completion part as well - can see above that you have it installed. You do not need to run the command to install it yourself afterwards as brew takes care of it. That command is for those who install via the pkg or download the binary directly from the releases page here.

The permissions error is because a user called workbrew owns that directory - looks like a service account that Workbrew uses to manage installing/uninstalling titles, so the user themselves can't write to that location directly.

If you re-open your Terminal after installing and type jamf-cli followed by a tab key, does it show more commands? If so, then shell completion is working properly.

[ondrish]

I have just checked if the completion actually works, and sadly it doesn't. Tested in native Terminal app and in Ghostty, both should have the same settings (zsh shell default config) but both are not able to access the completion.

[neilmartin83]

What happens if you try: jamf-cli completion zsh > ~/.zsh/completions/_jamf-cli

Then quit/re-open Terminal?

I'm thinking could add a fallback to the completion command to install in the default user location if the brew prefix isn't writable...

[ondrish]

Tested, multiple things I found:

1. i did not install zsh, was using the apple-provided version, and that one doesn't create or use .zsh folder, at least it was not present in my ~.
2. after i created ~/.zsh/completions/ so that the command you gave me would succeed, i re-launched Terminal but still completions were not working for me.

What was present in my ~ was:
.zprofile
.zsh_history
.zsh_sessions

.zprofile contains just the brew path eval:
% cat .zprofile
eval "$(/opt/workbrew/bin/brew shellenv)"

[neilmartin83]

I don't have Workbrew so can't test, but Homebrew 100% works for me after clearing out /opt/homebrew/share/zsh/site-functions/_jamf-cli and doing a manual uninstall/re-install with brew.

Re the default location: Do you have a ~/.zshrc ? If so does it containautoload -Uz compinit? I believe this is needed.

https://docs.brew.sh/Shell-Completion