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

# Installation

> Install the Entire CLI on your system

## 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.

Both Homebrew channels are distributed as casks.

<Tabs>
  <Tab title="macOS (Homebrew)">
    The easiest way to install on macOS is via Homebrew:

    ```bash theme={null}
    # Stable
    brew tap entireio/tap
    brew install --cask entire
    ```

    To install the nightly channel:

    ```bash theme={null}
    brew tap entireio/tap
    brew install --cask entire@nightly
    ```

    To upgrade the stable channel:

    ```bash theme={null}
    brew upgrade --cask entire
    ```

    To upgrade the nightly channel:

    ```bash theme={null}
    brew upgrade --cask entire@nightly
    ```
  </Tab>

  <Tab title="Linux">
    Use the install script for Linux.

    Stable is the default:

    ```bash theme={null}
    curl -fsSL https://entire.io/install.sh | bash
    ```

    To install the nightly channel:

    ```bash theme={null}
    curl -fsSL https://entire.io/install.sh | bash -s -- --channel nightly
    ```

    Or download the binary directly:

    ```bash theme={null}
    # 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:

    ```bash theme={null}
    curl -LO https://github.com/entireio/cli/releases/latest/download/entire-linux-arm64.tar.gz
    ```
  </Tab>

  <Tab title="Windows (Scoop)">
    Scoop currently supports the stable channel only:

    ```bash theme={null}
    scoop bucket add entire https://github.com/entireio/scoop-bucket.git
    scoop install entire/cli
    ```

    To update:

    ```bash theme={null}
    scoop update entire/cli
    ```
  </Tab>

  <Tab title="From Source">
    If you have Go 1.21+ installed, you can build from source:

    ```bash theme={null}
    go install github.com/entireio/cli/cmd/entire@latest
    ```

    Or clone and build manually:

    ```bash theme={null}
    git clone https://github.com/entireio/cli.git
    cd cli
    go build -o entire ./cmd/entire
    sudo mv entire /usr/local/bin/
    ```
  </Tab>
</Tabs>

## Verify Installation

After installation, verify that Entire is working:

```bash theme={null}
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.

<Tabs>
  <Tab title="Bash">
    Add to your `~/.bashrc`:

    ```bash theme={null}
    source <(entire completion bash)
    ```
  </Tab>

  <Tab title="Zsh">
    Add to your `~/.zshrc`:

    ```bash theme={null}
    source <(entire completion zsh)
    ```
  </Tab>
</Tabs>

## Updating

To update Entire, use the command that matches how you installed it:

<Tabs>
  <Tab title="Homebrew">
    Stable:

    ```bash theme={null}
    brew upgrade --cask entire
    ```

    Nightly:

    ```bash theme={null}
    brew upgrade --cask entire@nightly
    ```
  </Tab>

  <Tab title="Scoop">
    Stable:

    ```bash theme={null}
    scoop update entire/cli
    ```

    Nightly is not currently available via Scoop.
  </Tab>

  <Tab title="Install Script">
    Stable:

    ```bash theme={null}
    curl -fsSL https://entire.io/install.sh | bash
    ```

    Nightly:

    ```bash theme={null}
    curl -fsSL https://entire.io/install.sh | bash -s -- --channel nightly
    ```
  </Tab>

  <Tab title="From Source">
    ```bash theme={null}
    go install github.com/entireio/cli/cmd/entire@latest
    ```
  </Tab>
</Tabs>

## Release Channels

Choose a channel based on how much change you want to absorb:

* `stable`: default channel, recommended for most users.
* `nightly`: newer prerelease builds that may change more frequently.

Supported install paths by channel:

* Homebrew stable: `brew tap entireio/tap && brew install --cask entire`
* Homebrew nightly: `brew tap entireio/tap && brew install --cask entire@nightly`
* Scoop stable: `scoop install entire/cli`
* `install.sh` stable: `curl -fsSL https://entire.io/install.sh | bash`
* `install.sh` nightly: `curl -fsSL https://entire.io/install.sh | bash -s -- --channel nightly`
* From source: manual/development flow, not a managed release channel

## Uninstalling

<Tabs>
  <Tab title="Homebrew">
    ```bash theme={null}
    brew uninstall --cask entire
    ```
  </Tab>

  <Tab title="Manual">
    ```bash theme={null}
    sudo rm /usr/local/bin/entire
    ```

    Also remove any configuration:

    ```bash theme={null}
    rm -rf ~/.config/entire
    ```
  </Tab>
</Tabs>

## Next Steps

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Get started with your first session
  </Card>

  <Card title="CLI Commands" icon="terminal" href="/cli/commands">
    Learn all available commands
  </Card>
</CardGroup>