Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-env Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:04:27 2018 GMT+0.
| • Introduction: | What cl-env 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 |
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.
(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.
Clone this repo
Run make test
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The cl-env system: |
Evan M Jones (https://evanjon.es/) <me@evanjon.es>
MIT
Easily parse .env files. That’s it!
cl-env.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files: |
| • The cl-env.asd file: | ||
| • The cl-env/package.lisp file: | ||
| • The cl-env/cl-env.lisp file: |
Next: The cl-env/package<dot>lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
cl-env.asd
cl-env (system)
Next: The cl-env/cl-env<dot>lisp file, Previous: The cl-env<dot>asd file, Up: Lisp files [Contents][Index]
Previous: The cl-env/package<dot>lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
cl-env (system)
cl-env.lisp
split (function)
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The cl-env package: |
package.lisp (file)
common-lisp
split (function)
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]
Small wrapper around (uiop:getenv). :default always you to specify a default variable. If the current environment does not have a value.
cl-env.lisp (file)
Reads the environment file, splits it up, and injects into current environment.
cl-env.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal functions: |
Previous: Internal definitions, Up: Internal definitions [Contents][Index]
Simple function, similar to String.prototype.split in JavaScript
cl-env.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: | C F L |
|---|
| Jump to: | C F L |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | F G I S |
|---|
| Jump to: | F G I S |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | C P S |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| C | |||
cl-env: | The cl-env system | ||
cl-env: | The cl-env package | ||
| | |||
| P | |||
Package, cl-env: | The cl-env package | ||
| | |||
| S | |||
System, cl-env: | The cl-env system | ||
| | |||
| Jump to: | C P S |
|---|