The dotenv Reference Manual

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 4.0 beta 2 "William Riker" on Thu Sep 15 04:38:47 2022 GMT+0.

Table of Contents


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


2 Systems

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


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

2.1 dotenv

Ease pain with working with .env files.

Author

Victor Polevoy <fx@thefx.co>

License

MIT

Version

0.1.0

Dependency

str (system).

Source

dotenv.asd.

Child Components

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   [Contents][Index]

3.1.1 dotenv/dotenv.asd

Source

dotenv.asd.

Parent Component

dotenv (system).

ASDF Systems

dotenv.


3.1.2 dotenv/package.lisp

Source

dotenv.asd.

Parent Component

dotenv (system).

Packages

dotenv.


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

3.1.3 dotenv/dotenv.lisp

Dependency

package.lisp (file).

Source

dotenv.asd.

Parent Component

dotenv (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


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

4.1 dotenv

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


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

5.1 Public Interface


5.1.1 Ordinary functions

Function: load! (&optional names)

Reads provided .env files.

Package

dotenv.

Source

dotenv.lisp.

Function: read-vars (vars)

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

Package

dotenv.

Source

dotenv.lisp.

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.


5.2 Internals


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

5.2.1 Special variables

Special Variable: *dot-env-data*
Package

dotenv.

Source

dotenv.lisp.


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

5.2.2 Ordinary functions

Function: get-env (name &optional default)
Package

dotenv.

Source

dotenv.lisp.

Function: parse-env-string (string)

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

Package

dotenv.

Source

dotenv.lisp.


Appendix A Indexes


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

A.1 Concepts


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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

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

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

Jump to:   *  
S