The cl-env Reference Manual

Table of Contents

The cl-env Reference Manual

This is the cl-env Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:10:29 2020 GMT+0.

1 Introduction

cl-env

cl-env is a project for loading environment variables from .env files into the current environment. Storing configuration in the environment separate from code is based on The Twelve-Factor App methodology.

Calling (cl-env:init) will attempt to load the .env file in the current working directory into your environment (accessible with (uiop:getenv)). If there is no file nothing will be loaded into your environment.

Usage

(cl-env:init) ;; load .env for the same directory as current directory.

or

(cl-env:init #p"~/Projects/your-cool-project/.env") ;; load .env from a specific directory.

or

(cl-env:init (merge-pathnames (truename ".") ".env")) ;; load .dev.env from current directory.

Runnings tests

1. Clone this repo

2. Run make test

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cl-env

Author

Evan M Jones (https://evanjon.es/) <me@evanjon.es>

License

MIT

Description

Easily parse .env files. That’s it!

Source

cl-env.asd (file)

Components

• package.lisp (file)
• cl-env.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 cl-env.asd

Location

cl-env.asd

Systems

cl-env (system)

3.1.2 cl-env/package.lisp

Parent

cl-env (system)

Location

package.lisp

Packages

cl-env

3.1.3 cl-env/cl-env.lisp

Dependency

package.lisp (file)

Parent

cl-env (system)

Location

cl-env.lisp

Exported Definitions

• getenv (function)
• init (function)

Internal Definitions

split (function)

4 Packages

Packages are listed by definition order.

4.1 cl-env

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• getenv (function)
• init (function)

Internal Definitions

split (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: getenv KEY &key DEFAULT

Small wrapper around (uiop:getenv). :default always you to specify a default variable. If the current environment does not have a value.

Package

cl-env

Source

cl-env.lisp (file)

Function: init &optional FILEPATH

Reads the environment file, splits it up, and injects into current environment.

Package

cl-env

Source

cl-env.lisp (file)

5.2 Internal definitions

5.2.1 Functions

Function: split SOMESTRING &key DELIM

Simple function, similar to String.prototype.split in JavaScript

Package

cl-env

Source

cl-env.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types