# @helix-sleep/envault

> Sync your .env file with Envault.

Latest version **3.2.0** (published 2022-07-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @helix-sleep/envault
pnpm add @helix-sleep/envault
yarn add @helix-sleep/envault
bun add @helix-sleep/envault
```

Provides the command `envault`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.2.0 |
| Published | 2022-07-20 |
| First published | 2022-07-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 7 |
| Unpacked size | 16.1 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Envault |
| Maintainers | kristoffertonning |
| Keywords | oclif |

## Links

- npm: https://www.npmjs.com/package/@helix-sleep/envault
- Repository: https://github.com/envault/cli
- Issues: https://github.com/envault/cli/issues
- npm.io page: https://npm.io/package/@helix-sleep/envault

## Dependencies (7)

- [axios](https://npm.io/package/axios.md) ^0.21.1
- [tslib](https://npm.io/package/tslib.md) ^1.14.1
- [cli-ux](https://npm.io/package/cli-ux.md) ^5.5.1
- [dotenv](https://npm.io/package/dotenv.md) ^8.2.0
- [@oclif/config](https://npm.io/package/@oclif/config.md) ^1.17.0
- [@oclif/command](https://npm.io/package/@oclif/command.md) ^1.8.0
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^3.2.1

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 3.2.0 (latest) — 2022-07-20

## README

# Envault CLI

The Envault CLI allows you to connect to your [Envault server](https://github.com/envault/enevault) and sync its credentials to your local .env file.

## Usage

To use the Envault CLI, you must have [Node.js](https://nodejs.org/) installed on your computer.

On your Envault dashboard, you will find an initialization command for each environment, which you can run to establish a connection to your Envault server, and pull your variables. This command only needs to be run the first time you connect your .env to Envault. An example initialization command:

```
npx envault vault.envault.dev 84632 iCNaGGLou6v0mRas
```

After you've run your environment initialization command for the first time, you can pull your .env again easily:

```
npx envault
```

### Options

By default, Envault will not pull variables that are not already present in your .env file. To enable this behaviour, use the `--constructive` flag:

```
npx envault --constructive
```

You are able to customise the name of your .env file using the `--filename` flag:

```
npx envault vault.envault.dev 84632 iCNaGGLou6v0mRas --filename=.myenv
```

The Envault CLI will sometimes prompt you to confirm your actions, especially those made in constructive mode. To bypass these prompts, use the `--force` flag:

```
npx envault --force
```

## Need Help?

🐞 If you spot a bug with Envault, please [submit a detailed issue](https://github.com/envault/envault/issues/new), and wait for assistance.

🤔 If you have a question or feature request, please [start a new discussion](https://github.com/envault/envault/discussions/new).

🔐 If you discover a vulnerability within Envault, please review our [security policy](https://github.com/envault/cli/blob/master/SECURITY.md).

---
_Source: https://npm.io/package/@helix-sleep/envault · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._