https://github.com/mikkoi/env-assert

Ensure that the environment variables match what you need, or abort.
https://github.com/mikkoi/env-assert

bash containers environment-variables hacktoberfest perl perl-module perl-script

Last synced: 3 months ago
JSON representation

Ensure that the environment variables match what you need, or abort.

• Host: GitHub
• URL: https://github.com/mikkoi/env-assert
• Owner: mikkoi
• License: artistic-2.0
• Created: 2023-02-14T15:02:20.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-04-06T20:35:11.000Z (3 months ago)
• Last Synced: 2025-04-06T21:30:00.854Z (3 months ago)
• Topics: bash, containers, environment-variables, hacktoberfest, perl, perl-module, perl-script
• Language: Perl
• Homepage: https://metacpan.org/dist/Env-Assert
• Size: 187 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: Changes
  • Contributing: CONTRIBUTING.md
  • License: LICENSE-Artistic-2.0
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# envassert

Ensure that the environment variables match

what is requested, or abort.

# DESCRIPTION

**envassert** checks that your runtime environment, as defined

with environment variables, matches with what you want.

You can define your required environment in a file.

Default file is **.envdesc** but you can use any file.

It is advantageous to use **envassert** for example when running

a container. If you check your environment for missing or

wrongly defined environment variables at the beginning of

the container run, your container will fail sooner instead

of in a later point in execution when the variables are needed.

# SYNOPSIS

envassert [options]

Options:

    --help

    --man

    --version

    --break-at-error

    --env-description

## INSTALLATION

### Packaging

[![Packaging status](https://repology.org/badge/vertical-allrepos/env-assert.svg)](https://repology.org/project/env-assert/versions)

### CLI interface without dependencies

The **envassert** command is also available

as self contained executable.

You can download it and run it as it is without

additional installation of CPAN packages.

Of course, you still need Perl, but Perl comes with any

normal Linux installation.

This can be convenient if you want to, for instance,

include **envassert** in a docker container build.

    curl -LSs -o envassert https://raw.githubusercontent.com/mikkoi/env-assert/main/envassert.self-contained

    chmod +x ./envassert

# LICENSE

This software is copyright (c) 2023 by Mikko Koivunalho.

This is free software; you can redistribute it and/or modify it under

the same terms as the Perl 5 programming language system itself.

Terms of the Perl programming language system itself:

a) the GNU General Public License as published by the Free

   Software Foundation; either version 1, or (at your option) any

   later version, or

b) the "Artistic License"

The complete licenses are in the files LICENSE-Artistic-2.0 and LICENSE-GPL-3

within this repository. If these files are missing, they can be downloaded

from the following urls:

    * https://www.gnu.org/licenses/

    * https://www.perlfoundation.org/artistic-license-20.html