bwrb config
Manage vault-wide configuration options.
Synopsis
Section titled “Synopsis”bwrb config <subcommand>Subcommands
Section titled “Subcommands”| Subcommand | Description |
|---|---|
| list | Show configuration values |
| edit | Edit configuration values |
Available Options
Section titled “Available Options”| Option | Description | Values |
|---|---|---|
link_format | How relations are formatted | wikilink, markdown |
editor | Terminal editor command | Path or command |
visual | GUI editor command | Path or command |
open_with | Default app for opening notes | system, editor, visual, obsidian |
obsidian_vault | Obsidian vault name for URI scheme | String |
default_dashboard | Dashboard used when no name is passed | Dashboard name or empty string |
excluded_directories | Directory prefixes excluded from discovery and targeting | JSON string array |
date_format | Pattern for generated full dates and unambiguous parsing | String using YYYY, MM, and DD tokens |
date_granularity | Default coarsest precision for date fields | day, month, year |
mention_exclude_types | Types excluded as mention targets | JSON string array |
mention_exclude_paths | Path globs excluded as mention targets | JSON string array |
mention_link_once | Limit auto-fixes to one link per note/target pair | Boolean |
This is the command’s complete editable subset. Nested calendars definitions
remain a schema workflow while guided calendar authoring is tracked in
#790. Advanced
mention_fuzzy_threshold and mention_corpus_* tuning also remains
schema-only. Edit those settings directly in .bwrb/schema.json and check the
result with bwrb schema validate.
When unset, date_format is YYYY-MM-DD and date_granularity is day.
Through config edit, date_format requires each of YYYY, MM, and DD
exactly once. Supported patterns include YYYY-MM-DD, MM/DD/YYYY,
DD/MM/YYYY, and DD-MM-YYYY.
Gregorian date fields are canonicalized to YYYY-MM-DD when written, while
partial dates remain ISO (YYYY-MM or YYYY). The configured pattern lets
Bowerbird parse matching generated or user-supplied full dates without guessing
their month/day order. It also applies to generated date placeholders outside
date frontmatter fields. Once date_format is explicitly set, non-ISO full-date
input must match that pattern; canonical YYYY-MM-DD and permitted ISO partials
remain accepted. Without an explicit setting, legacy unambiguous slash/dash
input remains accepted.
Configuration Location
Section titled “Configuration Location”Configuration is stored in .bwrb/schema.json under the config key.
Display vault configuration values.
Synopsis
Section titled “Synopsis”bwrb config list [options] [option]Arguments
Section titled “Arguments”| Argument | Description |
|---|---|
option | Specific option to show (shows all if omitted) |
Options
Section titled “Options”| Option | Description |
|---|---|
--output <format> | Output format: text, json |
Examples
Section titled “Examples”# Show all configurationbwrb config list
# Show specific optionbwrb config list open_withbwrb config list link_formatbwrb config list date_format
# JSON outputbwrb config list --output jsonModify vault configuration values.
Synopsis
Section titled “Synopsis”bwrb config edit [options] [option]Arguments
Section titled “Arguments”| Argument | Description |
|---|---|
option | Specific option to edit (prompts if omitted) |
Options
Section titled “Options”| Option | Description |
|---|---|
--json <value> | Set value directly (JSON mode) |
--output <format> | Output format: text, json |
Examples
Section titled “Examples”Interactive Editing
Section titled “Interactive Editing”# Edit with pickerbwrb config edit
# Edit specific optionbwrb config edit open_withbwrb config edit link_formatbwrb config edit date_granularityNon-interactive (JSON) Mode
Section titled “Non-interactive (JSON) Mode”# Set string valuebwrb config edit open_with --json '"editor"'
# Set complex valuebwrb config edit obsidian_vault --json '"My Vault"'
# Set date writing and partial-date defaultsbwrb config edit date_format --json '"DD/MM/YYYY"'bwrb config edit date_granularity --json '"month"'
# Set arrays and booleansbwrb config edit excluded_directories --json '["Archive","Templates"]'bwrb config edit mention_exclude_paths --json '["Imports/**"]'bwrb config edit mention_link_once --json 'true'See Also
Section titled “See Also”- Schema — Schema structure