openv 🔐

🚨 BEFORE
PGHOST=some.hostname.com PGUSER=root PGPASSWORD=top-secret psql

✅ AFTER
openv my-1password-secure-note -c psql

openv enables you to easily manage application environment variables in 1Password without putting them plaintext on disk (e.g. into .env-files, .zshrc, .bashrc, ...).

This way you can continue using 1Password as a central secret storage and even share certain environment configurations with your colleagues via 1Password shared vaults!

Setup

1. Installation
   using Homebrew

   brew cask install 1password-cli
   brew tap tobiastrinks/openv
   brew install openv

   or using npm (requires installing the 1Password CLI manually: official page)

   npm install -g @ttrinks/openv

2. 1Password CLI Setup
   openv uses the official 1Password CLI to access your vaults and set secrets. More information: https://support.1password.com/command-line-getting-started/

   op signin example.1password.com [email protected]

3. (Optional) enable auto-completion
   Auto-completion helps you when selecting the secret from your 1Password CLI by name. (Only fully supported on MacOS)

   openv install-completion

Usage

1. create new Secure Note on 1Password
   The notes content must comply to the .env RFC 2 specification

2. start 1Password session

   op signin

3. Run your command with secret environment variables

   openv postgres-staging -c psql

Advanced usage

Options
      --help          View manual
      --command, -c   The command you want to execute
      --env, -e       Manually overwrite values from 1Password note

The --command flag is optional. If left blank openv will return the environment variables from your 1Password Secure Note to stdout. You can utilize this for more advanced use-cases like exporting them to your current shell:

export $(openv <secure-note-name>)

You can also specify multiple --env flags, to overwrite certain Secure Note variables. This enables you to easily adjust the environment without changing the Secure Note or creating multiple just slightly different Secure Notes to cover your use-cases.

openv <secure-note-name> -c <command> -e DBHOST=localhost -e DBPASSWORD=1234

Security

As openv is able to read the secrets you store in the requested Secret Note you should inspect the source code to ensure that you trust the software.

openv is unable to read your Master-Password, as it relies on the 1password-cli to access your vault.

License (MIT)

Copyright 2020 Tobias Trinks

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.