Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
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.
• Introduction | What dotenv is all about | |
• Systems | The systems documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
This is a project to parse dotenv (.env
) files.
You already know what that means, don't you?
This project provides all the necessary functions for
interaction with dotenv files (usually it is .env
).
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"))
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")
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The dotenv system |
Victor Polevoy <fx@thefx.co>
MIT
Ease pain with working with .env files.
0.1.0
str
dotenv.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
• The dotenv.asd file | ||
• The dotenv/package.lisp file | ||
• The dotenv/dotenv.lisp file |
Next: The dotenv/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
dotenv.asd
dotenv (system)
Next: The dotenv/dotenv․lisp file, Previous: The dotenv․asd file, Up: Lisp files [Contents][Index]
Previous: The dotenv/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
dotenv (system)
dotenv.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The dotenv package |
package.lisp (file)
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported functions |
Previous: Exported definitions, Up: Exported definitions [Contents][Index]
Reads provided .env files.
dotenv.lisp (file)
Reads provided environment variables into *dot-env-data*.
dotenv.lisp (file)
Reads the .env or env variable with such name. Returns passed default value or nil if not found
dotenv.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal special variables | ||
• Internal functions |
Next: Internal functions, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
dotenv.lisp (file)
Previous: Internal special variables, Up: Internal definitions [Contents][Index]
dotenv.lisp (file)
Reads environment string (KEY=VALUE). Returns the pair on success, NIL otherwise.
dotenv.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | D F L |
---|
Jump to: | D F L |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | F G L P R V |
---|
Jump to: | F G L P R V |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
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: Variable index, Up: Indexes [Contents][Index]
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 |
---|