bartvdbraak/keyweave
1
0
Fork 0
mirror of https://github.com/bartvdbraak/keyweave.git synced 2025-04-27 06:41:21 +00:00
Code Issues Projects Releases Packages Wiki Activity
Fetches secrets from Azure Key Vault and weaves them into a convenient .env file
70 commits 16 branches 12 tags 1.2 MiB
Rust 70.7%
Bicep 29.3%
Find a file
Bart van der Braak b4ae19740f
Merge pull request #17 from bartvdbraak/feat/homebrew-releases 
Fix version input for Homebrew by removing prefix
2023-11-09 12:10:53 +01:00
.github/workflows fix: use version without prefix 2023-11-09 12:10:06 +01:00
src fix: formatting of tx.send() 2023-11-08 01:14:01 +01:00
.gitignore feat: ignore .env files 2023-11-06 00:38:39 +01:00
Cargo.lock feat: version bump incl linux-raw-sys, getrandom 2023-11-09 00:48:01 +01:00
Cargo.toml feat: bump version to 0.2.1 2023-11-09 00:43:59 +01:00
LICENSE feat: added author and package information 2023-11-06 00:38:05 +01:00
README.md docs: add instructions for installation 2023-11-09 00:38:55 +01:00
renovate.json Add renovate.json 2023-11-05 17:32:09 +00:00

README.md

Keyweave

Cluster

Keyweave is an open-source tool crafted to seamlessly fetch secrets from Azure Key Vault and weave them into a convenient .env file. Developed in Rust, Keyweave stands out for its efficiency and user-friendly design, making it an ideal choice for managing your application's secrets.

Features

  • Fetch Secrets: Retrieve secrets securely from Azure Key Vault.
  • Filtering: Optionally filter the secrets to be retrieved by name.
  • Output Customization: Choose the name of the output file, defaulting to .env.
  • Azure Default Credentials: Utilizes Azure default credentials for authentication.

Prerequisites

Before diving into Keyweave, ensure you have the following prerequisites:

  • Azure Account: Log into your Azure tenant and set up the right subscription, along with any Access Policies required for you to read and list secrets from your Key Vault.
az login --tenant "your-tenant-guid"
az account set --subscription "your-subscription-guid"

Installation (MacOS, Linux)

For MacOS and Linux systems, installation is a breeze with Homebrew. Simply run:

brew tap bartvdbraak/keyweave
brew install keyweave

Manual Download

If you prefer manual installation or need binaries for different platforms (including an executable for Windows), visit the Releases page of this GitHub repository.

Building from Source

Keyweave is built with Cargo, the Rust package manager.

To build Keyweave from source, follow these steps:

git clone https://github.com/bartvdbraak/keyweave.git
cd keyweave
cargo build --release

Once built, run Keyweave using Cargo:

cargo run -- --vault_name <VAULT_NAME> [--output <FILE>] [--filter <FILTER>]

Usage

With the binary on your PATH, run Keyweave as follows:

keyweave --vault_name <VAULT_NAME> [--output <FILE>] [--filter <FILTER>]
  • --vault_name <VAULT_NAME>: Sets the name of the Azure Key Vault.
  • --output <FILE>: (Optional) Sets the name of the output file (default: .env).
  • --filter <FILTER>: (Optional) Filters the secrets to be retrieved by name.

Example

keyweave --vault_name my-key-vault --output my-env-file.env --filter my-secret

License

Keyweave is licensed under the GPLv3 License. See LICENSE for more details.

Contributing

We welcome contributions! Feel free to submit pull requests, report issues, or suggest new features. Your input helps make Keyweave even better.