Install gh0stcli
Install gh0stcli on macOS, Linux, or Windows, and check that it works.
gh0stcli is the program that connects your computer and your AI assistant to gh0stcloud. Installing it takes a few minutes. This page covers every path, including what to do when the package manager it needs is not on your machine yet.
If you just want the fastest route, the Starter page picks it for you.
Which path is yours
| Your system | Use |
|---|---|
| macOS | Homebrew |
| Linux | Homebrew |
| Windows | The installer download |
| Windows, managed by IT with Chocolatey | Chocolatey |
macOS and Linux
gh0stcli is published through Homebrew.
1. Check whether Homebrew is installed
Open Terminal and run:
brew --version
If that prints a version, continue. If it reports that the command was not found, install Homebrew first by following the official instructions at brew.sh. We do not wrap that installer. Use the one Homebrew publishes.
2. Install gh0stcli
brew install gh0stservice/tap/gh0stcli
3. Check that it worked
gh0stcli --version
Windows: the installer
This is the path we recommend. It needs no package manager and no administrator rights.
1. Download
- Download for Windows: for almost every PC
- Download for Windows on Arm: only if your PC reports an Arm processor under Settings → System → About
2. Run it
Windows may warn that the publisher is not verified. We are still setting up Windows code signing, so this warning is expected for now. Choose More info, then Run anyway.
The installer sets gh0stcli up for your Windows account only. It does not change anything for other users on the machine and does not ask for administrator rights.
3. Open a new terminal and check
The installer adds gh0stcli to your PATH, but terminals that were already open do not pick that up. Open a new PowerShell or Terminal window, then run:
gh0stcli --version
Removing it later
Open Settings → Apps → Installed apps, find gh0stcli, and choose Uninstall. You can also run uninstall-gh0stcli.exe --uninstall from the install folder.
Windows: Chocolatey
Use this if your machine already manages software with Chocolatey.
Not recommended yet. An initial version did clear review in the Chocolatey community feed, but we release faster than the feed reviews, so what is published there is regularly several versions behind. Use the installer above until we solve that differently.
1. Check whether Chocolatey is installed
Open PowerShell and run:
choco --version
If the command is not found, install Chocolatey first by following the official instructions at chocolatey.org/install.
2. Open PowerShell as administrator
Chocolatey installs software for the whole machine, so it needs elevated rights. Right-click the Start button and choose Terminal (Administrator), or search for PowerShell, right-click it, and choose Run as administrator.
3. Install gh0stcli
choco install gh0stcli
Next: connect your AI assistant
One command checks the tools a deployment needs, installs the missing ones once you agree, and connects your assistant:
gh0stcli setup
It asks before installing anything, and it never signs you in to GitHub. gh auth login stays your own step. If you have both Claude Code and Codex, add --agent claude or --agent codex so it connects the one you actually use.
This gives your assistant two things:
- Your account: your projects, applications, deployments, and their status.
- Your logs and metrics: so it can tell you what your app is actually doing, not just what you asked for. This one stays quiet until you deploy gh0steye from Operated Applications in the portal. Setup says so when it connects it.
Restart your assistant afterwards so it picks up the new tools.
If you have not used Claude Code or Codex before, read Work safely with an AI assistant first. It explains which assistants are supported and how to keep control of what they do.
Doing it by hand
If you would rather see each step, gh0stcli deps lists the tools and --fix installs them. gh0stcli setup --help shows exactly what it will connect before it does anything.
Next: sign in
gh0stcli auth login
This opens sign-in in your browser. Your password and session stay out of the conversation with your assistant.
If something does not work
The command is not found after installing. Open a new terminal window. Changes to PATH only apply to terminals started afterwards.
Homebrew says the tap cannot be found. Check the spelling: the formula is gh0stservice/tap/gh0stcli, with a zero in gh0stservice.
Windows blocks the download. Some browsers and virus scanners hold back programs that few people have downloaded yet. Keep the file, then run it. The download always comes from gh0stcloud.
Still stuck. Ask your assistant to run gh0stcli deps and describe what it reports, or get in touch.