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

# Install the Companion

> Install, update and uninstall the yocrow command on macOS, Linux and Windows.

The Companion is a single binary named `yocrow`. The installer downloads the build for your system and checks it against the release `checksums.txt` before installing it.

## Install

**macOS and Linux**

```bash theme={null}
curl -fsSL https://get.yocrow.dev/production/install.sh | sh
```

```text nocopy theme={null}
Downloading Yocrow Companion v1.0.0 for darwin/arm64
Installed 1.0.0 to /Users/you/.local/bin/yocrow
Added /Users/you/.local/bin to PATH in /Users/you/.zshrc
Open a new terminal to use yocrow, or source /Users/you/.zshrc
Next, run: yocrow login
```

The binary goes to `~/.local/bin`, which is added to your PATH. Open a new terminal to use `yocrow`.

**Windows**

Run this in PowerShell.

```powershell theme={null}
irm https://get.yocrow.dev/production/install.ps1 | iex
```

The binary goes to `%LOCALAPPDATA%\Yocrow\bin`, which is added to your PATH. Open a new terminal to use `yocrow`.

## Verify the install

```bash theme={null}
yocrow --version
```

```text nocopy theme={null}
1.0.0
```

## Agent skills

Run `yocrow` with no arguments to install the agent skills, or use [`yocrow skills install`](https://docs.yocrow.dev/cli/skills).

## Installer options

Set these variables before the install command.

| Variable | Purpose | Example |
| - | - | - |
| `YOCROW_VERSION` | Install a specific release tag | `YOCROW_VERSION=v1.0.0` |
| `YOCROW_INSTALL_DIR` | Install to another directory | `YOCROW_INSTALL_DIR=/opt/yocrow/bin` |
| `YOCROW_NO_MODIFY_PATH` | Skip adding the install directory to PATH | `YOCROW_NO_MODIFY_PATH=1` |
| `YOCROW_ARCH` | Windows only. Force `amd64` or `arm64` | `$env:YOCROW_ARCH = "arm64"` |

## Update

Run the install command again. It replaces the binary and keeps your sign-in and provider connections.

## Uninstall

Sign out first so the device is revoked and its connections are released.

**macOS and Linux**

```bash theme={null}
yocrow logout --yes
rm ~/.local/bin/yocrow
```

**Windows**

```powershell theme={null}
yocrow logout --yes
Remove-Item "$env:LOCALAPPDATA\Yocrow\bin\yocrow.exe"
```


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