Installation

Install envcheck using cargo, pre-built binaries, or build from source

System Requirements

envcheck is a cross-platform tool that works on:

• macOS (x86_64, ARM64/Apple Silicon)
• Linux (x86_64, ARM64)
• Windows (x86_64)

No runtime dependencies are required - envcheck is a single, statically-linked binary.

Installation Methods

Cargo (Recommended)

If you have Rust installed, the easiest way to install envcheck is via cargo:

cargo install envcheck

This will download, compile, and install the latest version of envcheck from crates.io.

Don’t have Rust installed? Get it from rustup.rs

Verify Installation

envcheck --version

You should see output like:

envcheck 0.1.0

Pre-built Binaries

Download pre-built binaries from the GitHub releases page.

1. Download the Binary

   Choose the appropriate binary for your platform:

   • macOS (Apple Silicon): envcheck-macos-arm64
   • macOS (Intel): envcheck-macos-x86_64
   • Linux (x86_64): envcheck-linux-x86_64
   • Windows: envcheck-windows-x86_64.exe

   # Example for macOS Apple Silicon
   curl -LO https://github.com/dotandev/envcheck/releases/latest/download/envcheck-macos-arm64
   
2. Make it Executable (Unix only)

   On macOS and Linux, make the binary executable:

   chmod +x envcheck-macos-arm64
   
3. Move to PATH

   Move the binary to a directory in your PATH:

   # macOS/Linux
   sudo mv envcheck-macos-arm64 /usr/local/bin/envcheck
   

   On Windows, move envcheck-windows-x86_64.exe to a directory in your PATH, such as C:\Windows\System32\ or add a custom directory to your PATH.

4. Verify Installation

   envcheck --version
   

Build from Source

Building from source gives you the latest development version and allows you to customize the build.

1. Install Rust

   If you haven’t already, install Rust from rustup.rs:

   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
   
2. Clone the Repository

   git clone https://github.com/dotandev/envcheck.git
   cd envcheck
   
3. Build the Project

   Build the release binary:

   cargo build --release
   

   The compiled binary will be at target/release/envcheck.

4. Install the Binary

   Install to your system:

   cargo install --path .
   

   Or manually copy the binary:

   sudo cp target/release/envcheck /usr/local/bin/
   
5. Verify Installation

   envcheck --version
   

Building from source requires a working Rust toolchain (1.70.0 or later recommended).

Platform-Specific Notes

macOS

On macOS, you may see a security warning when first running envcheck if you downloaded a pre-built binary. To allow it:

xattr -d com.apple.quarantine /usr/local/bin/envcheck

Alternatively, go to System Preferences → Security & Privacy and click Allow Anyway when prompted.

Linux

On most Linux distributions, envcheck works out of the box. Ensure /usr/local/bin is in your PATH:

echo $PATH | grep -q "/usr/local/bin" || export PATH="/usr/local/bin:$PATH"

Add the export command to your .bashrc or .zshrc to make it permanent.

Windows

On Windows, if you’re using PowerShell, you may need to update your execution policy:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

Updating envcheck

Cargo

Update to the latest version:

cargo install envcheck --force

Pre-built Binaries

Download the latest release and replace your existing binary following the installation steps above.

From Source

Pull the latest changes and rebuild:

cd envcheck
git pull
cargo install --path . --force

Uninstalling

Cargo

cargo uninstall envcheck

Manual Installation

Remove the binary from your PATH:

# macOS/Linux
sudo rm /usr/local/bin/envcheck

On Windows, delete the executable from wherever you placed it.

Troubleshooting

Command not found after installation

Ensure the installation directory is in your PATH:

# Check your PATH
echo $PATH

# If cargo's bin directory is missing, add it:
export PATH="$HOME/.cargo/bin:$PATH"

Add the export to your shell profile (.bashrc, .zshrc, etc.) to make it permanent.

Permission denied when running envcheck

Make sure the binary is executable:

chmod +x $(which envcheck)

Cargo build fails

Ensure you have the latest Rust version:

rustup update

envcheck requires Rust 1.70.0 or later.

SSL/TLS errors on Linux

Some validators check network connectivity. Ensure you have OpenSSL installed:

# Debian/Ubuntu
sudo apt-get install libssl-dev

# Fedora/RHEL
sudo dnf install openssl-devel

Next Steps

Quick Start Guide

Now that envcheck is installed, learn how to use it with our quick start guide