https://github.com/maximilian-krauss/env-snitch

https://github.com/maximilian-krauss/env-snitch

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/maximilian-krauss/env-snitch
• Owner: maximilian-krauss
• Created: 2021-06-28T07:16:30.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-03-06T22:04:35.000Z (over 1 year ago)
• Last Synced: 2024-09-04T18:25:17.515Z (2 months ago)
• Language: TypeScript
• Size: 1.46 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# env-snitch

Little snitch (not the network one) tool to help creating .env files from k8s and sourcecode.

## How to use

- Open a new terminal window

- Log into your kubernetes cluster of choice from which you want to extract the environment variables from (make sure that `kubectl` works)

- Run the following command `npx env-snitch@latest .` (the dot at the end passes the current directory to env-snitch but you can also specifiy any directory you want)

## How does it work?

`env-snitch` scans through all .js or .ts files in the given directory and searches for usages of environment variables (by accessing them via `(process).env.SOME_VARIABLE`). It then connects to k8s, looks for the pod running your application and extracts the environment variables from the pod and prints them into stdout.

## Available flags and options

Alongside the required directory as first argument you can pass the following parameter to `env-snitch`:

- **--appName** - Specifies the name of the application as it is labelled inside the kubernetes cluster. If not provided, env-snitch tries to use the `name` specified inside the `package.json`.

- **--file={FILENAME}** - You can specify an additional file to output the environment variables. The final path will then be combined between the given source code directory and the specified filename.

- **--ignoreMissing** - By default, `env-snitch` will print missing environment variables (for which no variable exists inside k8s) as `VARIABLE_NAME=`. If you want to omit those you can use this flag.

- **--objectName** - This is the object name which holds the environment data. By default it's `env` as in `process.env` but you can override with this flag if your configuration data is stored in an different object.

## Is this a good idea?

Probably not. You should never connect to production data and execute `env-snitch`. You actually circumvent any measure taken to protect secrets. But if you need to connect to your development stage it's the best approach to autogenerate an up2date .env file.

Use at your own risk.