Skip to main content

Indie game storeFree gamesFun gamesHorror games
Game developmentAssetsComics
SalesBundles
Jobs
TagsGame Engines

How to install Butler on a Mac?

A topic by RecoveryUnit4649 created Jun 08, 2021 Views: 1,793 Replies: 5
Viewing posts 1 to 6

I've been trying to follow the instructions, but I can't seem to get it to work. 

According to the documentation, I should follow the Linux instructions. 

1. Extract the butler-darwin-amd64 folder to the directory of my choice and run

chmod +x "path to file"

2. Next, run

export PATH="$PATH:path to file"

But nothing happens. Does anyone know what I'm doing wrong?

Moderator (3 edits) (+1)

I’ve done this on Linux, on Mac it should be similar. I will explain the steps here, let me know where exactly you get stuck. Since you are mentioning terminal commands, I’ll assume you are at least a bit familiar with the terminal.


chmod +x “path to file”

This command targets a file and makes it executable. This should be a file named butler inside the directory you extracted. So if you extracted everything in

~/butler_directory

The command should like something like

chmod +x ~/butler_directory/butler

It shouldn’t return any error, or anything else.


export PATH=”$PATH:path to file”

This command tells your terminal where to look for executable files. For example when you run the “chmod” command above, the terminal knows to find it at “/usr/bin/chmod” (or wherever else based on your OS). So this command will allow you to simply type “butler” and execute that file, without the need to navigate to its directory every time. Based on the directory above, the command should target a directory, like this:

export PATH=”$PATH:~/butler_directory/”

You shouldn’t see anything after running this. Make sure to close the terminal and open it again (to apply changes). Now on the new terminal, try typing

butler –version

If it works, then success! You’ve installed butler and can proceed with configuring it to be connected to your account.


Hope that helps, let me know if you get stuck anywhere and I’ll do my best.

I extracted the butler-darwin-amd64 folder to my Documents. I tired the top two commands, closed the terminal, then ran butler -version. But I received "zsh command not found". I did the same for the bottom two (I wasn't sure if the path to the directory was supposed to be the path to the folder or the path to the file for the second command), and received the same error.

(1 edit)

please try following the directions on the page carefully, or else at the butler page click report and then report a bug then tell what's happening, and they should help you from there, if that can't work  then restart your computer

I gave up trying to get this to be a command...I just drag butler into terminal and before hitting enter type push then drag and drop the zip which adds the path and then type in the user/game:channel stuff. Going to make a txt doc with user/game info so I can just copy paste from there. Works for me and I will retain the rest of my hair....I have tried so many things but it ends with "zsh: command not found: butler" . 

(6 edits)

Installing this is easy:

* Download ZIP archive and unpack

'sudo mv path-to-butler-folder /usr/local' 
cd /usr/local/bin
'sudo ln -s butler /usr/local/name-of-butler-folder-you-moved'

If you're on modern macOS with zsh as your default Terminal shell, be sure to set your Itch API key in EITHER of these ways:

* Edit ~/.zshrc (~/.bashrc on older releases that use bash as the default Terminal shell) and enter the following:

export BUTLER_API_KEY="key-you-generated-on-itch"

Save your .zshrc or .bashrc file and then in your Terminal window execute the command below. Use the filename associated with your Terminal shell.

'source ~/.zshrc' or 'source ~/.bashrc'

OR save your key in the file 

~/Library/Application Support/itch/butler_creds

All this done, you should be able to 'butler --version' and get the version of your installed butler. If successful, 'butler login' is next ...