Gathering detailed insights and metrics for biome
0.3.3
640,433Installations
npm install biomeDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
5.12.0
NPM Version
3.8.6
Score
83.9
Supply Chain
90.3
Quality
68.4
Maintenance
25
Vulnerability
96.1
License
Releases
Unable to fetch releases
Contributors
1
validate.email 🚀
Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.
Download Statistics
Total Downloads
640,433
Last Day
3,233
Last Week
20,566
Last Month
77,489
Last Year
623,649
Maintainers
1
Package Meta Information
Latest Version
0.3.3
Package Id
biome@0.3.3
Size
145.64 kB
NPM Version
3.8.6
Node Version
5.12.0
Total Downloads
Cumulative downloads
Total Downloads
640,433
Last Day
-2.5%
3,233
Compared to previous day
Last Week
12.7%
20,566
Compared to previous week
Last Month
39.8%
77,489
Compared to previous month
Last Year
4,581.3%
623,649
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Manage environment variables in a sane way. Never push up secrets again!
- Enforces a clear separation of secrets and code.
- All secrets are in one configurable place. (by default,
~/.biome) - Associate any number of variables with any number of projects.
- Easily create complex variable structures that inherit from one-another.
Installation
1npm install -g biome
Usage
1$ biome --help 2 Usage: biome [options] [command] 3 4 Commands: 5 6 init [project] Create a new project with the specified name, and save an alias to this folder. 7 add [project] Add a variable to a project. Specify like NAME=value. 8 use [project] Open a shell with a project's associated variables included. 9 edit [project] Open $EDITOR with the project's associated environment variables. 10 vars [options] [project] Echo all variables. 11 12 Options: 13 -h, --help output usage information 14 -V, --version output the version number 15 16 Examples: 17 18 $ biome init project 19 $ biome add project FOO=bar BAZ="I'm a teapot" 20 $ biome use project
Workflow
To set up an environment, first run biome init project to set up a new environment called
project. Then, to add new variables to an environment, run biome add project KEY=value. To
perform more complicated configurations, edit the environment directly with biome edit project.
Once you'd like to use the environment, run biome use project. A new instance of $SHELL will be
spawned containing all the configured variables, plus a few Biome-specific ones. To view your
current environment, type biome.
How it works:
For each project, biome creates 2 files: a local Biomefile and a global project.json.
// Biomefile
{
"name": "project"
}
// project.json
{
"VARIABLE": "value"
}
The local Biomefile can be committed to source control because it just contains a reference to the
global project. The project.json is stored in ~/.biome/project.json, where project is replaced
with the identifier in the Biomefile. This file is where the environment variables themselves are
actually stored. Since each user can have a separate project.json for each system, everyone can
customize their config to suit their needs.
Configuration
BIOME_LOCAL_NAME: The name of the file in the project that references an environment. Defaults toBiomefile.BIOME_FOLDER_NAME: The name of the folder that biome stores all secrets within. Defaults to~/.biome.
Tips and Tricks
- Want to include other environments into a project? Within the project's environment, add the
special key
$includemapping to an array of envornments. For example,"$include": ["another", "environment", "here"]. - Easily give new users a simple way to enter values. Within the
Biomefile, define a property calledtemplate. Each key oftemplateshould be the variable name, while each value should be its default value. For example:
1{ 2 "name": "my-project", 3 "template": { 4 "KEY": "value" 5 } 6}
Then, when the user runs biome init, they'll be prompted for the values specified. Above, they'd
be prompted for KEY, and given a default choice of "value".
- Don't want to hardcode templates into a project? As an argument to
biome init, specify a template url after the project name, likebiome init project http://example.com/template.json.
Created by Ryan Gaus
No vulnerabilities found.
No security vulnerabilities found.