Generate
keychain_generateRead-only
Generate a password or passphrase with customizable length, character sets, and word options. Optionally reveal the secret value for immediate use.
Instructions
Generate a password or passphrase with bw generate. This never mutates the vault; pass reveal=true to return the value, and NOREVEAL or KEYCHAIN_NOREVEAL force redaction.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| uppercase | No | Include uppercase letters when generating a password. | |
| lowercase | No | Include lowercase letters when generating a password. | |
| number | No | Include numeric digits when generating a password. | |
| special | No | Include special characters when generating a password. | |
| passphrase | No | Generate a word-based passphrase instead of a password. | |
| length | No | Password length in characters, between 5 and 256. | |
| words | No | Passphrase word count, between 3 and 50. | |
| minNumber | No | Minimum number of digits to include. | |
| minSpecial | No | Minimum number of special characters to include. | |
| separator | No | Separator to use between words in passphrase mode. | |
| capitalize | No | Capitalize passphrase words when supported by bw. | |
| includeNumber | No | Include a number in passphrase mode when supported by bw. | |
| ambiguous | No | Allow ambiguous characters in generated passwords. | |
| reveal | No | Whether secret values are returned; default false and can be forced false by NOREVEAL. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |