Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/dotandev/envcheck/llms.txt

Use this file to discover all available pages before exploring further.

Stop “Works on My Machine” Problems

Fast, declarative environment validation for tools, versions, environment variables, and ports. Built in Rust for speed and reliability.

Get StartedInstallation Guide

Get Started in Minutes

Install envcheck and validate your development environment with a simple YAML configuration.

1

Install envcheck

Install envcheck using cargo or download from releases:
cargo install envcheck
2

Initialize configuration

Generate a default .envcheck.yaml configuration file:
envcheck init
This creates a starter configuration you can customize for your project.
3

Run validation

Run envcheck to validate your environment:
envcheck
You’ll see clear, colored output showing which checks passed and which need attention.

Comprehensive Environment Validation

Everything you need to ensure development environments are consistent across your team.

Tool Validation

Check if required tools are installed and verify versions using semver comparison.

Environment Variables

Validate that required environment variables are set and optionally match regex patterns.

Port Availability

Ensure critical ports are available before starting your application.

File & Directory Checks

Verify required files exist and have correct permissions.

Network Connectivity

Check connectivity to external services and APIs.

CI/CD Integration

JSON output format for seamless integration with CI/CD pipelines.

Ready-to-Use Examples

Jump-start your configuration with examples for popular stacks.

Node.js

Validate Node.js version, npm, and environment variables.

View example

Python

Check Python version, virtual environment, and dependencies.

View example

Rust

Validate Rust toolchain, cargo, and project configuration.

View example

Go

Ensure Go version and module configuration are correct.

View example

Rails

Validate Ruby version, Rails, and database configuration.

View example

All Commands

Explore all CLI commands and options.

View reference

Built by the Community, for the Community

envcheck is an open-source project designed to be community-driven. We welcome contributions of all kinds — from bug reports to new validators.

Start ContributingView on GitHub