Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cuducos/createnv
🧞‍♀️Automagically creates .env files
https://github.com/cuducos/createnv
cli dev developer-tools devtools dotenv hacktoberfest
Last synced: 25 days ago
JSON representation
🧞‍♀️Automagically creates .env files
- Host: GitHub
- URL: https://github.com/cuducos/createnv
- Owner: cuducos
- License: bsd-3-clause
- Created: 2020-03-18T20:15:25.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-01T00:09:19.000Z (about 1 month ago)
- Last Synced: 2024-11-10T17:02:37.540Z (about 1 month ago)
- Topics: cli, dev, developer-tools, devtools, dotenv, hacktoberfest
- Language: Rust
- Homepage:
- Size: 63.5 KB
- Stars: 41
- Watchers: 3
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-rust-tools - createnv - 🧞‍♀️Automagically creates .env files. (Shell/Terminal)
README
# Createnv [](https://github.com/cuducos/createnv/actions/workflows/tests.yml)
A simple CLI to create `.env` files.
## Motivation
I use `.env` file to decouple configuration from application in many projects, and I see that many newcomers might struggle in creating this file.
Thus, I created this package to offer a better user interface for creating configuration files in the format of `.env`.
## Example
Using the sample `.env.sample` in this repository:
[](https://asciinema.org/a/311482)
You can now experiment by yourself, or try more advanced `.env.sample` such as the `tests/.env.sample` or [Bot Followers's `.env.sample`](https://github.com/cuducos/bot-followers/blob/master/.env.sample).
## Install
You can download the binary for your platform from the [releases page](https://github.com/cuducos/createnv/releases), for example:
```console
$ curl -LO https://github.com/cuducos/createnv/releases/download/v0.0.3/createnv-x86_64-unknown-linux-gnu.tar.gz
$ tar -xzvf createnv-x86_64-unknown-linux-gnu.tar.gz
$ rm createnv-x86_64-unknown-linux-gnu.tar.gz
$ chmod a+x createnv
$ mv createnv /usr/local/bin/
```
### Compile from source
It is simple with [Rust's `cargo`](https://www.rust-lang.org/tools/install):
```console
$ cargo install --path .
```
## Usage
To use the default values (reads the sample from `.env.sample` and write the result into `.env`):
```console
$ createnv
```
### Options
| Option | Description | Default |
|---|---|---|
| `--target` | File to write the result | `.env` |
| `--source` | File to use as a sample | `.env.sample` |
| `--chars-for-random-string` | Characters used to create random strings | All ASCII letters, numbers and a few extra characters (`!@#$%^&*(-_=+)`) |
### Flags
| Option | Description |
|---|---|
| `--stdout` | Write to `stdout` instead of a file |
| `--overwrite` | Do not ask before overwriting files |
| `--use-default` | Do not ask for input on fields that have a default value |
## Format of sample files
Createnv reads the sample file and separate lines in blocks, splitting at empty lines. It follows a few rules:
1. The first line is required to be a **title**
2. The second line might be a **description** or a **variable**
3. The remaining lines should be **variables**
### Title
The first line of the block should start with a `#` character, followed by a space. The title value is the remaining text after the `#` and space.
#### Example
```
# Hell Yeah!
```
In this case, the title is _Hell yeah!_ (not _# Hell yeah!_).
### Description (_optional_)
If the second line follows the syntax of a _title_ line, it's text (without the `# `) is considered a _description_ and is used to give more information to the user about the variables from this block.
### Variables
There are three types of variables:
#### Regular
Each block might one or more variable lines. The syntax requires a _name of variable_ using only capital letters, numbers, or underscore, followed by an equal sign.
What comes after the equal sign is _optional_. This text is considered the default value of this variable.
The human description of this variable is also _optional_. You can create one by placing a comment at the end of the line. That is to say, any text after a sequence of **two spaces, followed by the `#` sign and one extra space**, is the human description of that variable.
##### Example
```
NAME=
```
This is a valid variable line. It has a name (_NAME_), no default value, and no human description. We can add a default value:
```
NAME=Cuducos
```
This is still a valid variable line. It has a name(_NAME_), and a default value (_Cuducos_). Yet, we can add a human description:
```
NAME=Cuducos # What is your name?
```
Now it's a complete variable with a name (_NAME_), a default value (_Cuducos_), and a human description (_What is your name?_)
#### Random values
If you want to have a variable with a random value, you can set its default value to `` and Createnv will take care of it. Optionally you can specify how long this variable should be with `:int`.
You can use the `--chars-for-random-string` option to specify which characters to be used in the random value.
##### Example
```
SECRET_KEY=
TOKEN=
```
The first line will create a `SECRET_VALUE` with random characters and random length between 64 and 128 chars.
The second line will create a `TOKEN` with random value and with exactly 32 characters.
#### Auto generated
Finally, you can combine existing variables _within the same block_ to create a new variable (without prompting your user to combine them), the syntax is similar to f-strings in Python..
##### Example
```
NAME= # What is your name?
PERIOD= # Is it morning, afternoon, or evening?
GREETING=Good {PERIOD}, {NAME}!
```
In this case, Createnv only asks the user for `NAME` and `PERIOD`, and creates `GREETING` automagically.