> ## Documentation Index
> Fetch the complete documentation index at: https://developers.parkes.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install and update the macOS CLI, verify your version, and enable shell completions.

## Requirements

* macOS on Apple Silicon or Intel.
* Homebrew and the GitHub CLI (`gh`).
* Read access to the private `ParkesAI/homebrew-internal` repository, including organization SSO authorization if required.

The CLI is not currently distributed as a public npm package or Linux/Windows installer. If you do not have access to the private tap, ask your Parkes contact about CLI availability.

## Install

If `gh` is not installed:

```bash theme={null}
brew install gh
```

Check `gh auth status`. If you need to sign in or configure Git credentials:

```bash theme={null}
gh auth login
gh auth setup-git
```

Then install the CLI:

```bash theme={null}
brew tap ParkesAI/internal
HOMEBREW_GITHUB_API_TOKEN="$(gh auth token)" brew install ParkesAI/internal/parkes
parkes --version
```

Homebrew needs the environment token to download private release assets, even if Git access to the tap works. Keep shell tracing disabled when running this command. Do not paste a literal GitHub token into a command or configuration file.

GitHub authentication grants access to the download. [Parkes authentication](https://developers.parkes.ai/cli/AUTHENTICATION.md) is a separate step.

## Upgrade

Version **0.1.2** supports the current organization-scoped resource routes and includes authentication and long-running-command fixes. Earlier releases use removed organization-prefixed routes.

```bash theme={null}
brew update
HOMEBREW_GITHUB_API_TOKEN="$(gh auth token)" brew upgrade ParkesAI/internal/parkes
parkes --version
```

If the version does not change, check which executable your shell finds:

```bash theme={null}
type -a parkes
brew list --versions parkes
```

A manually installed binary earlier in `PATH` can take precedence over Homebrew. Check it before replacing or removing any existing installation.

## Shell completions

`parkes completion` writes a completion script for `bash`, `zsh`, `fish`, `powershell`, or `elvish`. For zsh, load it after `compinit` in your shell configuration:

```bash theme={null}
source <(parkes completion zsh)
```

For bash:

```bash theme={null}
source <(parkes completion bash)
```

Homebrew releases also include shell-completion files. Use your shell's normal completion setup to load them.

## Troubleshooting

A repository-not-found or private-asset download error usually means your GitHub login lacks repository or SSO access. Check that access before retrying installation.

The macOS binaries are not Apple-notarized. Follow your organization's software policies if macOS blocks execution.

## Uninstall

If you also want to revoke the selected Parkes login, run `parkes auth logout` before uninstalling:

```bash theme={null}
brew uninstall parkes
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.