## System Requirements

- **Operating System:** macOS, Linux, Windows
- **Git:** Version 2.25 or later
- **Shell:** Bash or Zsh (for hook installation)

## Installation Methods

Entire currently ships two release channels:

- `stable`: recommended for most users. This is the default channel for Homebrew, Scoop, and `install.sh`.
- `nightly`: prerelease builds for users who want the latest changes earlier.

Entire uses Homebrew casks so the CLI can be installed from the same signed release artifacts used by other install methods.

- macOS (Homebrew)
- Linux
- Windows (Scoop)
- From Source

The easiest way to install on macOS is via Homebrew. First, tap and trust the Entire tap. This is a one-time setup:

```
brew tap entireio/tap
brew trust entireio/tap
```

Homebrew 5.2.0 and 6.0.0 and later require trusting a third-party tap with `brew trust` before installing its casks. See [Tap Trust](https://docs.brew.sh/Tap-Trust).

Then install the stable channel:

```
brew install --cask entire
```

Or install the nightly channel:

```
brew install --cask entire@nightly
```

To upgrade the stable channel:

```
brew upgrade --cask entire
```

To upgrade the nightly channel:

```
brew upgrade --cask entire@nightly
```

Use the install script for Linux. Stable is the default:

```
curl -fsSL https://entire.io/install.sh | bash
```

To install the nightly channel:

```
curl -fsSL https://entire.io/install.sh | bash -s -- --channel nightly
```

Or download the binary directly:

```
# Download the latest release
curl -LO https://github.com/entireio/cli/releases/latest/download/entire-linux-amd64.tar.gz

# Extract and install
tar -xzf entire-linux-amd64.tar.gz
sudo mv entire /usr/local/bin/
```

For ARM64 systems:

```
curl -LO https://github.com/entireio/cli/releases/latest/download/entire-linux-arm64.tar.gz
```

Scoop currently supports the stable channel only:

```
scoop bucket add entire https://github.com/entireio/scoop-bucket.git
scoop install entire/cli
```

To update:

```
scoop update entire/cli
```

If you have Go 1.21+ installed, you can build from source:

```
go install github.com/entireio/cli/cmd/entire@latest
```

Or clone and build manually:

```
git clone https://github.com/entireio/cli.git
cd cli
go build -o entire ./cmd/entire
sudo mv entire /usr/local/bin/
```

## Verify Installation

After installation, verify that Entire is working:

```
entire version
```

You should see output like:

```
entire version 1.0.0 (abc1234)
```

The `entire` binary needs to be on your `$PATH` for agent hooks and Git hooks to work.

## Shell Completion

Entire supports shell completion for Bash and Zsh.

- Bash
- Zsh

Add to your `~/.bashrc`:

```
source <(entire completion bash)
```

Add to your `~/.zshrc`:

```
source <(entire completion zsh)
```

## Uninstalling

- Homebrew
- Manual

```
brew uninstall --cask entire
```

```
sudo rm /usr/local/bin/entire
```

Also remove any configuration:

```
rm -rf ~/.config/entire
```

## Next Steps

[**Quickstart** \\\ Get started with your first session](https://docs.entire.io/quickstart)

[**Updating** \\\ Update the Entire CLI.](https://docs.entire.io/updating)

[**CLI Commands** \\\ Learn all available commands](https://docs.entire.io/cli-reference)