Skip to content

Commit

Permalink
add reference format to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
arkinmodi committed May 10, 2023
1 parent 2f1b448 commit b063aa9
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ Within Bitwarden, you need to create the item to hold your environment variables

![Custom Fields in the Bitwarden App](assets/readme_bitwarden_custom_fields.png)

The name of the environment variable can be different from the name for the Custom Field. Additionally, you can have environment variables that point to multiple Bitwarden Items within the same file. (e.g., `ENV_1` points to Bitwarden Item 1 and `ENV_2` points to Bitwarden Item 2.)

### `bwenv generate`

```sh
Expand All @@ -43,6 +45,8 @@ bwenv generate demo

This command is for generating a `.env` file (filename is customizable with the `-f` flag). This will perform either a fuzzy search for the Bitwarden Item Name or ID. The founded environment variables will be appended to file (i.e., this will not overwrite existing data within the file).

The format for the secret reference string is `bwenv://<Bitwarden Item ID>/fields/<Custom Field Name>`.

### `bwenv run`

```sh
Expand Down

0 comments on commit b063aa9

Please sign in to comment.