crystal-env preview

README.md

crystal-env

This shard provides environment detection. The selected environment is configured using CRYSTAL_ENV environment variable.

Installation

Add this to your application's shard.yml:

dependencies:
  env:
    github: crystal-lang/crystal-env

Usage

• Add the following require in the application code. The default environment will be development.

require "env"

• In the spec/spec_helper.cr require env/spec before your app code. When running crystal spec the default environment will be test.

require "spec"
require "env/spec"
require "../your-app"

• Use the following methods to detect the environment

  • Crystal.env.development?
  • Crystal.env.production?
  • Crystal.env.test?

• Set CRYSTAL_ENV to development, production or test