Build from source

Homebrew is the recommended installation. Use this guide if you want to build or change Cue itself.

RequirementsCopy Anchor Link

You need macOS 13+, Apple Terminal or the VS Code integrated terminal running zsh, Node.js 22+, pnpm 10+, and Xcode Command Line Tools.

Build CueCopy Anchor Link

Run this from the repository root:

git clone https://github.com/8starlabs/cue.git
cd cue
pnpm install
pnpm build:app

The app is built at packages/cue/build/Cue.app.

Load it in zshCopy Anchor Link

Load the integration in the current Terminal session:

source "$PWD/packages/cue/zsh/cue.zsh"

To load Cue in future sessions in either terminal, add an absolute path to ~/.zshrc:

source "/path/to/cue/packages/cue/zsh/cue.zsh"

Replace /path/to/cue with your clone's path. Start a new Terminal session to apply it. The integration launches Cue in the background.

In VS Code, open a new integrated terminal after saving ~/.zshrc. If its shell is not zsh, run Terminal: Select Default Profile, choose zsh, and create a new terminal. Cue uses the same shell bridge in both apps; no VS Code extension is required.

Allow popup positioningCopy Anchor Link

If macOS asks, allow Cue under System Settings → Privacy & Security → Accessibility. Cue uses this access to position suggestions near the caret.

Update or removeCopy Anchor Link

Pull and rebuild from the repository root:

git pull --ff-only
pnpm install
pnpm build:app

Open a new Terminal session after rebuilding. If Cue is running, open Activity Monitor, select Cue, click the stop button, and choose Quit so the new session launches the updated app.

To uninstall, remove Cue's source line from ~/.zshrc, quit Cue if it is running, close existing Terminal windows, and delete your clone. Cue cleans up its temporary socket files when it starts again. You can also remove Cue from Accessibility settings. See Install Cue if you prefer the Homebrew version.