Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/envkey/go-envkeyfetch
MIRROR for envkey-fetch utility v2 and above
https://github.com/envkey/go-envkeyfetch
Last synced: 8 days ago
JSON representation
MIRROR for envkey-fetch utility v2 and above
- Host: GitHub
- URL: https://github.com/envkey/go-envkeyfetch
- Owner: envkey
- License: mit
- Created: 2021-01-13T15:45:10.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-05-13T19:30:49.000Z (over 3 years ago)
- Last Synced: 2023-07-27T22:05:17.216Z (over 1 year ago)
- Language: Go
- Homepage: https://www.envkey.com
- Size: 59.6 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# envkey-fetch
This library contains [EnvKey](https://www.envkey.com)'s core cross-platform fetching, decryption, verification, web of trust, redundancy, and caching logic. It accepts an `ENVKEY` generated by the [EnvKey App](https://www.github.com/envkey/envkey-app) and returns decrypted configuration for a specific app environment as json.
It is used by EnvKey's various Client Libraries, including [envkey-source](https://github.com/envkey/envkey-source) for bash, [envkey-ruby](https://github.com/envkey/envkey-ruby) for Ruby and Rails, [envkey-python](https://github.com/envkey/envkey-python) for Python, [envkey-node](https://github.com/envkey/envkey-node) for Node.js, and [envkeygo](https://github.com/envkey/envkeygo) for Go.
If you want to build an EnvKey library in a language that isn't yet officially supported, build some other type of integration, or simply play around with EnvKey on the command line, envkey-fetch is the library for you. If you just want to integrate EnvKey with your project, check out one of the aforementioned higher level libraries.
## Installation
envkey-fetch compiles into a simple static binary with no dependencies, which makes installation a simple matter of fetching the right binary for your platform and putting it in your `PATH`. An `install.sh` script is available to simplify this.
**Install via bash:**
```bash
curl "https://raw.githubusercontent.com/org2321/reponame/master/public/sdks/envkey-fetch/install.sh?$(date +%s)" | bash
```
**Install manually:**
Find the [release](https://github.com/envkey/envkey-fetch/releases) for your platform and architecture, and stick the appropriate binary somewhere in your `PATH` (or wherever you like really).
**Install from source:**
With Go installed, clone the project into your `GOPATH`. `cd` into the directory and run `go get` and `go build`.
**Cross-compile from source:**
To compile cross-platform binaries, make sure Go is installed, then install [goreleaser](https://goreleaser.com/) - follow instructions in the docs to do so.
Then to cross-compile, run:
`goreleaser`
Binaries for each platform will be output to the `dist` folder.
## Usage
```bash
envkey-fetch YOUR-ENVKEY [flags]
```
This will either write your the app environment's configuration associated with your `ENVKEY` as json to stdout or write an error message beginning with `error:` to stdout.
### Example json output
```json
{"TEST":"it","TEST_2":"works!"}
```
### Example error output
```text
error: ENVKEY invalid
```
### Flags
```text
--cache cache encrypted config as a local backup (default is false)
--cache-dir string cache directory (default is $HOME/.envkey/cache)
--client-name string calling client library name (default is none)
--client-version string calling client library version (default is none)
-h, --help help for envkey-fetch
--retries uint8 number of times to retry requests on failure (default 3)
--retryBackoff float retry backoff factor: {retryBackoff} * (2 ^ {retries - 1}) (default 1)
--timeout float timeout in seconds for http requests (default 10)
--verbose print verbose output (default is false)
-v, --version prints the version
```
## Further Reading
For more on EnvKey in general:
Read the [docs](https://docs.envkey.com).
Read the [integration quickstart](https://docs.envkey.com/integration-quickstart.html).
Read the [security and cryptography overview](https://security.envkey.com).
## Need help? Have questions, feedback, or ideas?
Post an [issue](https://github.com/envkey/envkey-fetch/issues) or email us: [[email protected]](mailto:[email protected]).