Giter Club home page Giter Club logo

heysops's Introduction

HeySops

A helpful utility for interfacing with sops. Inspired by git-secret

Configuration

Environment Variables

  • SOPS_PATH - Set the path to the sops binary. By default, it will search the path for the SOPS binary file.

Configuration File

HeySops uses a configuration file named .heysops.yaml or .heysops.yml. This file should be stored in the root of your repository, next to your .gitignore file.

Commands

Common Arguments

  • -c - Specify a .heysops.yaml file to use during execution.
  • -f - Force an action, such as overwriting files.
  • -v - Display informational log event entries

Init

  • heysops init - Creates a .heysops.yaml file in the current directory if it does not exist. This must be run before other commands. You can have multiple .heysops.yaml within a folder structure.

Encrypt

  • heysops encrypt - Encrypts all files that were previously encrypted with this tool. Uses the .heysops.yaml file in the local directory. If .heysops.yaml is not found in the current directory, it traverses upwards until it finds one. If it doesn't find one, it warns and exits.
  • heysops encrypt [file] - Encrypts the specified file, creating a new file alongside it with the .sops extension.
  • heysops encrypt --type {json,yaml,dotenv,binary} [file] - Encrypts the specified file, creating a new file alongside it with the .sops extension. Passes the specified --type to sops's --input-type argument. Will use the same type on decryption.

Decrypt

  • heysops decrypt - If no files are specified, it looks for a file named .heysops.yaml in the local directory. If .heysops.yaml is not found in the current directory, it traverses upwards until it finds one. If it doesn't find one, it warns and exits. Prompts if the decrypted file name already exists.
  • heysops decrypt [file] - Decrypts the specific file. Prompts if the decrypted file name already exists.

Clean

  • heysops clean - Removes all decrypted files if we have an encrypted copy.

Forget

  • heysops forget [file] - Untrack a file within .heysops.yaml. This will leave the file on the system and no longer interact with it through other commands.

heysops's People

Contributors

chapinb avatar

Watchers

 avatar

heysops's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.