System Requirements
- macOS, Linux, or Windows
- Git 2.25 or later
- Bash, Zsh, Fish, or PowerShell
- Windows PowerShell 5.1 or later, for the Windows PowerShell installer
Release Channels
Entire ships two release channels:stable: the default channel for Homebrew, Scoop,install.sh, andinstall.ps1nightly: prerelease builds available through Homebrew,install.sh, andinstall.ps1
install.ps1.
Install and Update Entire
Choose one installation method. Use the update command in the same tab when you want a newer release.- macOS with Homebrew
- Linux Install Script
- Linux Direct Download
- Windows with PowerShell
- Windows with Scoop
- Build from Source
Install the stable channel:Or install the nightly channel:The fully qualified cask name adds the
entireio/tap tap for you, so no separate brew tap step is needed.Update the channel you installed:Install While GitHub Is Unavailable
From v0.12.0 on, release archives are published toinstall.entire.com as well as to GitHub, and both install scripts download from install.entire.com first. The entire.com/install.sh and entire.com/install.ps1 addresses redirect to GitHub, so during a GitHub outage fetch the scripts from install.entire.com directly:
go install with an explicit version, such as go install github.com/entireio/cli/cmd/entire@v0.12.1, is served from the Go module proxy and also works.
Verify the Installation
Run:git-remote-entire. Git invokes this helper when a remote uses an entire:// URL. Verify that your shell can find both executables:
- macOS or Linux
- Windows
Installation and Data Locations
The executable location depends on the installation method:
Entire stores repository settings in
.entire/settings.json and personal repository overrides in .entire/settings.local.json. See Local and Project Settings for those files.
The CLI also uses these directories for each user:
XDG_CONFIG_HOME does not change the Entire config directory. Set ENTIRE_CONFIG_DIR when you need a different location.
Turn Off Update Checks
These settings need Entire CLI v0.12.3 or later. Set this variable to turn off update checks, notices, and prompts, including for plugins:config.json in your Entire config directory:
~/.config/entire/config.json
ENTIRE_NO_AUTO_UPDATE=0 or =false leaves the variable off, but can’t turn checks back on when config.json turns them off. If config.json can’t be parsed, Entire reports an error naming the file. Fix or remove the file.
Shell Completion
Entire generates shell completion scripts for Bash, Zsh, Fish, and PowerShell withentire completion. The steps below cover Bash and Zsh.
- Bash
- Zsh
Add this command to
~/.bashrc:Uninstall Entire
Use the command that matches your installation method.- Homebrew
- Linux Install Script or Direct Download
- Windows PowerShell Script
- Scoop
- Go
Stable:Nightly: