The cl-dotenv Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-dotenv Reference Manual

This is the cl-dotenv Reference Manual, version 0.1.0, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Mon Apr 08 13:15:00 2019 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

cl-dotenv - Load .env files from Common Lisp

Build Status Coverage Status

Tiny utility library for loading .env files.

Currently tested with: SBCL, Allegro, ECL

Usage

Calling load-env loads the environment from the specified .env file. Use any of the available nicknames cl-dotenv, .env or dotenv.

  (.env:load-env (merge-pathnames "./path/.env"))

Parsing rules

Installation

The package is available through Quicklisp.

(ql:quickload :cl-dotenv)

Dependencies

Contributing

All contributions are very much welcome. Please get familiar with the contributing guide.

Commands

Author

Inspiration

License

Licensed under the MIT License.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 cl-dotenv

Author

Olle Lauri Boström

License

MIT

Description

Utility library for loading .env files

Version

0.1.0

Dependencies
Source

cl-dotenv.asd (file)

Component

cl-dotenv.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-dotenv.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/cl-dotenv-20181018-git/cl-dotenv.asd

Systems

cl-dotenv (system)


Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl-dotenv/cl-dotenv.lisp

Parent

cl-dotenv (system)

Location

cl-dotenv.lisp

Packages

cl-dotenv

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 cl-dotenv

.ENV files are parsed according to the following rules.

∙ Empty lines are skipped.
∙ Lines beginning with # are treated as comments
∙ Empty values are treated as empty strings, e.j. ’EMPTY=’ sets the environment variable EMPTY to ”.

Source

cl-dotenv.lisp (file)

Nicknames
Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: load-env PATH
Package

cl-dotenv

Source

cl-dotenv.lisp (file)

Function: read-env PATH
Package

cl-dotenv

Source

cl-dotenv.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Conditions

Condition: duplicated-entry ()
Package

cl-dotenv

Source

cl-dotenv.lisp (file)

Direct superclasses

error (condition)

Direct methods
Direct slots
Slot: key
Initargs

:key

Readers

key (generic function)

Slot: prev-value
Initargs

:prev-value

Readers

prev-value (generic function)

Slot: value
Initargs

:value

Readers

value (generic function)

Condition: malformed-entry ()
Package

cl-dotenv

Source

cl-dotenv.lisp (file)

Direct superclasses

error (condition)

Direct methods

line (method)

Direct slots
Slot: line
Initargs

:line

Readers

line (generic function)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Functions

Function: %load-env ENV
Package

cl-dotenv

Source

cl-dotenv.lisp (file)

Function: read-entry LINE
Package

cl-dotenv

Source

cl-dotenv.lisp (file)

Function: whitespace-p CHAR
Package

cl-dotenv

Source

cl-dotenv.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Generic functions

Generic Function: key CONDITION
Package

cl-dotenv

Methods
Method: key (CONDITION duplicated-entry)
Source

cl-dotenv.lisp (file)

Generic Function: line CONDITION
Package

cl-dotenv

Methods
Method: line (CONDITION malformed-entry)
Source

cl-dotenv.lisp (file)

Generic Function: prev-value CONDITION
Package

cl-dotenv

Methods
Method: prev-value (CONDITION duplicated-entry)
Source

cl-dotenv.lisp (file)

Generic Function: value CONDITION
Package

cl-dotenv

Methods
Method: value (CONDITION duplicated-entry)
Source

cl-dotenv.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-dotenv.asd: The cl-dotenv<dot>asd file
cl-dotenv/cl-dotenv.lisp: The cl-dotenv/cl-dotenv<dot>lisp file

F
File, Lisp, cl-dotenv.asd: The cl-dotenv<dot>asd file
File, Lisp, cl-dotenv/cl-dotenv.lisp: The cl-dotenv/cl-dotenv<dot>lisp file

L
Lisp File, cl-dotenv.asd: The cl-dotenv<dot>asd file
Lisp File, cl-dotenv/cl-dotenv.lisp: The cl-dotenv/cl-dotenv<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %  
F   G   K   L   M   P   R   V   W  
Index Entry  Section

%
%load-env: Internal functions

F
Function, %load-env: Internal functions
Function, load-env: Exported functions
Function, read-entry: Internal functions
Function, read-env: Exported functions
Function, whitespace-p: Internal functions

G
Generic Function, key: Internal generic functions
Generic Function, line: Internal generic functions
Generic Function, prev-value: Internal generic functions
Generic Function, value: Internal generic functions

K
key: Internal generic functions
key: Internal generic functions

L
line: Internal generic functions
line: Internal generic functions
load-env: Exported functions

M
Method, key: Internal generic functions
Method, line: Internal generic functions
Method, prev-value: Internal generic functions
Method, value: Internal generic functions

P
prev-value: Internal generic functions
prev-value: Internal generic functions

R
read-entry: Internal functions
read-env: Exported functions

V
value: Internal generic functions
value: Internal generic functions

W
whitespace-p: Internal functions

Jump to:   %  
F   G   K   L   M   P   R   V   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   K   L   P   S   V  
Index Entry  Section

K
key: Exported conditions

L
line: Exported conditions

P
prev-value: Exported conditions

S
Slot, key: Exported conditions
Slot, line: Exported conditions
Slot, prev-value: Exported conditions
Slot, value: Exported conditions

V
value: Exported conditions

Jump to:   K   L   P   S   V  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   D   M   P   S  
Index Entry  Section

C
cl-dotenv: The cl-dotenv system
cl-dotenv: The cl-dotenv package
Condition, duplicated-entry: Exported conditions
Condition, malformed-entry: Exported conditions

D
duplicated-entry: Exported conditions

M
malformed-entry: Exported conditions

P
Package, cl-dotenv: The cl-dotenv package

S
System, cl-dotenv: The cl-dotenv system

Jump to:   C   D   M   P   S