Skip to content

Installation

This document describes how to install the Windsor CLI on your development workstation as well as configuring windsor hook in your shell.

Installing with Homebrew

brew update
brew tap windsorcli/cli
brew install windsor

Manual Installation

curl -L -o windsor_0.5.0_darwin_arm64.tar.gz https://github.com/windsorcli/cli/releases/download/v0.5.0/windsor_0.5.0_darwin_arm64.tar.gz && \
tar -xzf windsor_0.5.0_darwin_arm64.tar.gz -C /usr/local/bin && \
chmod +x /usr/local/bin/windsor

Verify the signature and checksum of the Windsor binary

To enhance security and confirm the integrity of your Windsor CLI installation, it is crucial to verify the downloaded binary. This involves checking the signature and checksum of the binary to ensure it has not been tampered with and is safe for use on your system. Follow the steps below to perform these verifications.

  1. Import the Public Key 

    gpg --keyserver keys.openpgp.org --recv-keys 05519B202F65EE4F

  2. Download the signature file: 

    curl -L -o windsor_0.5.0_checksums.txt.sig https://github.com/windsorcli/cli/releases/download/v0.5.0/windsor_0.5.0_checksums.txt.sig

  3. Download the checksum file: 

    curl -L -o windsor_0.5.0_checksums.txt https://github.com/windsorcli/cli/releases/download/v0.5.0/windsor_0.5.0_checksums.txt

  4. Verify the Signature: 

    gpg --verify windsor_0.5.0_checksums.txt.sig windsor_0.5.0_checksums.txt

  5. Verify the Checksum: 

    shasum -a 256 -c windsor_0.5.0_checksums.txt

Execute the following commands in PowerShell with administrative privileges:

New-Item -Path "C:\Program Files\Windsor" -ItemType Directory -Force ;
Invoke-WebRequest -Uri "https://github.com/windsorcli/cli/releases/download/v0.5.0/windsor_0.5.0_windows_amd64.tar.gz" -Headers @{"Accept"="application/octet-stream"} -OutFile "windsor_0.5.0_windows_amd64.tar.gz" ;
tar -xzf windsor_0.5.0_windows_amd64.tar.gz -C "C:\Program Files\Windsor" ;

Verify the signature and checksum of the Windsor binary

To enhance security and confirm the integrity of your Windsor CLI installation, it is crucial to verify the downloaded binary. This involves checking the signature and checksum of the binary to ensure it has not been tampered with and is safe for use on your system. Follow the steps below to perform these verifications.

  1. Import the Public Key 

    gpg --keyserver keys.openpgp.org --recv-keys 05519B202F65EE4F

  2. Download the signature file: 

    Invoke-WebRequest -Uri "https://github.com/windsorcli/cli/releases/download/v0.5.0/windsor_0.5.0_checksums.txt.sig" -OutFile "windsor_0.5.0_checksums.txt.sig"

  3. Download the checksum file: 

    Invoke-WebRequest -Uri "https://github.com/windsorcli/cli/releases/download/v0.5.0/windsor_0.5.0_checksums.txt" -OutFile "windsor_0.5.0_checksums.txt"

  4. Verify the Signature: 

    gpg --verify windsor_0.5.0_checksums.txt.sig windsor_0.5.0_checksums.txt

  5. Verify the Checksum: 

    Get-FileHash -Algorithm SHA256 -Path "windsor_0.5.0_checksums.txt" | Format-List


curl -L -o windsor_0.5.0_linux_amd64.tar.gz https://github.com/windsorcli/cli/releases/download/v0.5.0/windsor_0.5.0_linux_amd64.tar.gz && \
sudo tar -xzf windsor_0.5.0_linux_amd64.tar.gz -C /usr/local/bin && \
sudo chmod +x /usr/local/bin/windsor

Verify the signature and checksum of the Windsor binary

To enhance security and confirm the integrity of your Windsor CLI installation, it is crucial to verify the downloaded binary. This involves checking the signature and checksum of the binary to ensure it has not been tampered with and is safe for use on your system. Follow the steps below to perform these verifications.

  1. Import the Public Key 

    gpg --keyserver keys.openpgp.org --recv-keys 05519B202F65EE4F

  2. Download the signature file: 

    curl -L -o windsor_0.5.0_checksums.txt.sig https://github.com/windsorcli/cli/releases/download/v0.5.0/windsor_0.5.0_checksums.txt.sig

  3. Download the checksum file: 

    curl -L -o windsor_0.5.0_checksums.txt https://github.com/windsorcli/cli/releases/download/v0.5.0/windsor_0.5.0_checksums.txt

  4. Verify the Signature: 

    gpg --verify windsor_0.5.0_checksums.txt.sig windsor_0.5.0_checksums.txt

  5. Verify the Checksum: 

    sha256sum -c windsor_0.5.0_checksums.txt

Version Check

To verify the installation and check the version of the Windsor CLI, execute the following command:

windsor version

Shell Integration: Seamless Environment Management

Windsor acts as an environment variable manager in your shell. It dynamically injects environment variables into your shell as you switch contexts and work on various components in your project.

You can add the windsor hook to various shells as follows:

Add the following line at the end of the ~/.bashrc file: 

eval "$(windsor hook bash)"
Make sure it appears even after rvm, git-prompt, and other shell extensions that manipulate the prompt.

Add the following line at the end of the ~/.zshrc file: 

eval "$(windsor hook zsh)"

Add the following line to your config.fish file: 

eval (windsor hook fish)

Add the following line to your ~/.tcshrc file: 

eval `windsor hook tcsh`

Add the following line to your rc.elv file: 

eval (windsor hook elvish)

Add the following line to your PowerShell profile script: 

Invoke-Expression (& windsor hook powershell)