Skip to content

Commit

Permalink
Update readme with new config section
Browse files Browse the repository at this point in the history
  • Loading branch information
sschmid committed Nov 10, 2024
1 parent 2a30ce9 commit 9daf618
Showing 1 changed file with 27 additions and 14 deletions.
41 changes: 27 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -384,10 +384,11 @@ configuration file, which defaults to `~/.pwrc`.
To use multiple keychains, add your desired keychains to `~/.pwrc`, e.g.:

```bash
secrets.keychain-db
~/path/to/myproject.keychain-db
~/path/to/keepassxc.kdbx
~/path/to/gpg/secrets
[keychains]
secrets.keychain-db
~/path/to/myproject.keychain-db
~/path/to/keepassxc.kdbx
~/path/to/gpg/secrets
```

After configuring your keychains, continue using `pw` as usual. If no keychain
Expand Down Expand Up @@ -430,7 +431,28 @@ pw unlock <<< "${MY_PASSWORD}"

# Customization

Export or provide the following variables to customize and change `pw`'s default behaviour:
Configure `pw` in `~/.pwrc` with the following options:

```bash
[config]
password_length = 35
password_character_class = [:graph:]
clipboard_clear_time = 45

[plugins]
$PW_HOME/plugins/gpg
$PW_HOME/plugins/keepassxc
$PW_HOME/plugins/macos_keychain

[keychains]
secrets.keychain-db
~/path/to/myproject.keychain-db
~/path/to/keepassxc.kdbx
~/path/to/gpg/secrets
```

Additionally, you can use environment variables to customize `pw`. They will
override the settings in `~/.pwrc`.

```bash
# Default keychain used when not specified with -k
Expand All @@ -450,15 +472,6 @@ export PW_CLIP_TIME=45
export PW_RC=~/.mypwrc
```

Configure keychains in `~/.pwrc`

```bash
secrets.keychain-db
~/path/to/myproject.keychain-db
~/path/to/keepassxc.kdbx
~/path/to/gpg/secrets
```

# Plugin specific configuration

Some plugins support additional configuration options by appending them to the
Expand Down

0 comments on commit 9daf618

Please sign in to comment.