The dotenv Reference Manual

Table of Contents

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

The dotenv Reference Manual

This is the dotenv Reference Manual, version 0.1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 04:39:29 2022 GMT+0.


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

1 Introduction

dotenv

This is a project to parse dotenv (.env) files. You already know what that means, don't you?

Description

This project provides all the necessary functions for interaction with dotenv files (usually it is .env).

API

dot-env-load!

The function's prototype is:

(defun dot-env-load! (&optional names)

It reads the dotenv files provided in the optional list or reads only .env file is the list is empty or was not provided.

Usage:

;; Loads the `.env` only because the arguments list is empty.
(dot-env-load!)
;; Loads the provided files.
(dot-env-load! '(".env" "test.env"))

dot-env

The function's prototype is:

(defun dot-env (name &optional default)

It reads the value of a variable dotenv with passed name. If there is no such a variable there, it reads the process environment. If there is nothing too, it returns default or NIL.

Usage:

(dot-env-load!)
(dot-env "HOME")

License

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 dotenv

Author

Victor Polevoy <fx@thefx.co>

License

MIT

Description

Ease pain with working with .env files.

Version

0.1.0

Dependency

str

Source

dotenv.asd (file)

Components

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 dotenv.asd

Location

dotenv.asd

Systems

dotenv (system)


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

3.1.2 dotenv/package.lisp

Parent

dotenv (system)

Location

package.lisp

Packages

dotenv


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

3.1.3 dotenv/dotenv.lisp

Dependency

package.lisp (file)

Parent

dotenv (system)

Location

dotenv.lisp

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 dotenv

Source

package.lisp (file)

Use List

common-lisp

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


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

5.1.1 Functions

Function: load! &optional NAMES

Reads provided .env files.

Package

dotenv

Source

dotenv.lisp (file)

Function: read-vars VARS

Reads provided environment variables into *dot-env-data*.

Package

dotenv

Source

dotenv.lisp (file)

Function: value NAME &optional DEFAULT

Reads the .env or env variable with such name. Returns passed default value or nil if not found

Package

dotenv

Source

dotenv.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *dot-env-data*
Package

dotenv

Source

dotenv.lisp (file)


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

5.2.2 Functions

Function: get-env NAME &optional DEFAULT
Package

dotenv

Source

dotenv.lisp (file)

Function: parse-env-string STRING

Reads environment string (KEY=VALUE). Returns the pair on success, NIL otherwise.

Package

dotenv

Source

dotenv.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   D   F   L  
Index Entry  Section

D
dotenv.asd: The dotenv․asd file
dotenv/dotenv.lisp: The dotenv/dotenv․lisp file
dotenv/package.lisp: The dotenv/package․lisp file

F
File, Lisp, dotenv.asd: The dotenv․asd file
File, Lisp, dotenv/dotenv.lisp: The dotenv/dotenv․lisp file
File, Lisp, dotenv/package.lisp: The dotenv/package․lisp file

L
Lisp File, dotenv.asd: The dotenv․asd file
Lisp File, dotenv/dotenv.lisp: The dotenv/dotenv․lisp file
Lisp File, dotenv/package.lisp: The dotenv/package․lisp file

Jump to:   D   F   L  

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

A.2 Functions

Jump to:   F   G   L   P   R   V  
Index Entry  Section

F
Function, get-env: Internal functions
Function, load!: Exported functions
Function, parse-env-string: Internal functions
Function, read-vars: Exported functions
Function, value: Exported functions

G
get-env: Internal functions

L
load!: Exported functions

P
parse-env-string: Internal functions

R
read-vars: Exported functions

V
value: Exported functions

Jump to:   F   G   L   P   R   V  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*dot-env-data*: Internal special variables

S
Special Variable, *dot-env-data*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   D   P   S  
Index Entry  Section

D
dotenv: The dotenv system
dotenv: The dotenv package

P
Package, dotenv: The dotenv package

S
System, dotenv: The dotenv system

Jump to:   D   P   S