bartvdbraak/keyweave
1
0
Fork 0
mirror of https://github.com/bartvdbraak/keyweave.git synced 2025-04-28 07:11:21 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: correct flag used for vault name

Browse source
This commit is contained in:
Bart van der Braak 2023-12-01 20:24:40 +01:00
parent 9e735ea44d
commit 5adb3a2069
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -68,7 +68,7 @@ cargo build --release
Once built, run Keyweave using Cargo: Once built, run Keyweave using Cargo:
```sh ```sh
cargo run -- --vault_name <VAULT_NAME> [--output <FILE>] [--filter <FILTER>] cargo run -- --vault-name <VAULT_NAME> [--output <FILE>] [--filter <FILTER>]
``` ```
## Usage ## Usage
@ -76,17 +76,17 @@ cargo run -- --vault_name <VAULT_NAME> [--output <FILE>] [--filter <FILTER>]
With the binary on your `PATH`, run Keyweave as follows: With the binary on your `PATH`, run Keyweave as follows:
```sh ```sh
keyweave --vault_name <VAULT_NAME> [--output <FILE>] [--filter <FILTER>] keyweave --vault-name <VAULT_NAME> [--output <FILE>] [--filter <FILTER>]
``` ```
- `--vault_name <VAULT_NAME>`: Sets the name of the Azure Key Vault. - `--vault-name <VAULT_NAME>`: Sets the name of the Azure Key Vault.
- `--output <FILE>`: (Optional) Sets the name of the output file (default: `.env`). - `--output <FILE>`: (Optional) Sets the name of the output file (default: `.env`).
- `--filter <FILTER>`: (Optional) Filters the secrets to be retrieved by name. - `--filter <FILTER>`: (Optional) Filters the secrets to be retrieved by name.
## Example ## Example
```sh ```sh
keyweave --vault_name my-key-vault --output my-env-file.env --filter my-secret keyweave --vault-name my-key-vault --output my-env-file.env --filter my-secret
``` ```
## Documentation ## Documentation