Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dotenv-org/dotenv-vscode
Add auto-cloaking, auto-completion, in-code secret peeking, and more to VSCode.
https://github.com/dotenv-org/dotenv-vscode
dotenv dotenv-cli dotenv-vault env environment environment-variables visual-studio visual-studio-code visual-studio-code-extension visual-studio-extension vscode
Last synced: 5 days ago
JSON representation
Add auto-cloaking, auto-completion, in-code secret peeking, and more to VSCode.
- Host: GitHub
- URL: https://github.com/dotenv-org/dotenv-vscode
- Owner: dotenv-org
- License: mit
- Created: 2022-08-07T18:02:02.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-02-05T13:01:05.000Z (9 months ago)
- Last Synced: 2024-05-29T22:14:34.670Z (6 months ago)
- Topics: dotenv, dotenv-cli, dotenv-vault, env, environment, environment-variables, visual-studio, visual-studio-code, visual-studio-code-extension, visual-studio-extension, vscode
- Language: JavaScript
- Homepage: https://dotenv.org/vscode
- Size: 2.68 MB
- Stars: 69
- Watchers: 2
- Forks: 10
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# dotenv-vscode
#### Syntax highlighting, auto-cloaking, auto-completion, and in-code secret peeking.
## Install
Install using VSCode Command Palette
1. Go to `View -> Command Palette` or press `Ctrl+Shift+P`
2. Then enter `Install Extension`
3. Search for `Dotenv`
4. Select `Official Dotenv` and click `Install`
## Usage
### Syntax Highlighting
It just works. Open your `.env` files in VSCode, and they will now be syntax highlighted.
### Auto-cloaking
It just works. Open your `.env` files in VSCode, and they will be auto-cloaked. Click the 'Toggle auto-cloaking' link at the top of your `.env` file to toggle it off. Feel safer sharing your screen!
Multiple .env file types supported.
* .env
* .env.example
* .env.development
* .env.staging
* .env.production
* .env.vault
* .env.me
* .env.*
* .flaskenv
### Auto-completion
Start typing `process.env.` (or language specific env statement) and your cursor will be populated with auto-completion options directly from your .env file. Cool!
Multiple languages supported.
* JavaScript/TypeScript/NodeJS
* Ruby
* Python
* PHP
* Go
* Java
* C#
* Rust
### In-code secret peeking
Hover your mouse over a `process.env.SECRET_KEY` or a `ENV["SECRET_KEY"]`, and you will be able to peek at its value without having to open your .env file. Convenient!
Multiple languages supported.
* JavaScript/TypeScript/NodeJS
* Ruby
* Python
* PHP
* Go
* Java
* C#
* Rust
### dotenv-vault (included but optional)
Manage your secrets using dotenv-vault's all-in-one toolkit. Say goodbye to scattered secrets across multiple platforms and tools.
Read more about dotenv-vault here.
Usage is similar to git. Run `CMD+Shift+P` (or `Ctrl+Shift+P`) and start typing `dotenv`.
```bash
dotenv new
```
Follow those instructions and then run:
```bash
dotenv login
```
Then run push and pull
```bash
dotenv push
dotenv pull
```
See dotenv-vault in action:
Visit [dotenv.org/docs](https://www.dotenv.org/docs/security/overview?r=8) to learn more.
## Commands
```
dotenv new Create your project
dotenv login Log in to dotenv-vault
dotenv logout Log out
dotenv open Open project page
dotenv push Push .env securely
dotenv pull Pull .env securely
dotenv versions List version history
dotenv whoami Display the current logged in user
dotenv status Check dotenv-vault operational status
```
Visit [dotenv.org/docs](https://www.dotenv.org/docs/dotenv-vault?r=8) for details per command.
## CHANGELOG
See [CHANGELOG](CHANGELOG.md)
Thank you for using dotenv-vscode.