Skip to content

bwrb config

Manage vault-wide configuration options.

Terminal window
bwrb config <subcommand>
SubcommandDescription
listShow configuration values
editEdit configuration values
OptionDescriptionValues
link_formatHow relations are formattedwikilink, markdown
editorTerminal editor commandPath or command
visualGUI editor commandPath or command
open_withDefault app for opening notessystem, editor, visual, obsidian
obsidian_vaultObsidian vault name for URI schemeString
default_dashboardDashboard used when no name is passedDashboard name or empty string
excluded_directoriesDirectory prefixes excluded from discovery and targetingJSON string array
date_formatPattern for generated full dates and unambiguous parsingString using YYYY, MM, and DD tokens
date_granularityDefault coarsest precision for date fieldsday, month, year
mention_exclude_typesTypes excluded as mention targetsJSON string array
mention_exclude_pathsPath globs excluded as mention targetsJSON string array
mention_link_onceLimit auto-fixes to one link per note/target pairBoolean

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 is stored in .bwrb/schema.json under the config key.


Display vault configuration values.

Terminal window
bwrb config list [options] [option]
ArgumentDescription
optionSpecific option to show (shows all if omitted)
OptionDescription
--output <format>Output format: text, json
Terminal window
# Show all configuration
bwrb config list
# Show specific option
bwrb config list open_with
bwrb config list link_format
bwrb config list date_format
# JSON output
bwrb config list --output json

Modify vault configuration values.

Terminal window
bwrb config edit [options] [option]
ArgumentDescription
optionSpecific option to edit (prompts if omitted)
OptionDescription
--json <value>Set value directly (JSON mode)
--output <format>Output format: text, json
Terminal window
# Edit with picker
bwrb config edit
# Edit specific option
bwrb config edit open_with
bwrb config edit link_format
bwrb config edit date_granularity
Terminal window
# Set string value
bwrb config edit open_with --json '"editor"'
# Set complex value
bwrb config edit obsidian_vault --json '"My Vault"'
# Set date writing and partial-date defaults
bwrb config edit date_format --json '"DD/MM/YYYY"'
bwrb config edit date_granularity --json '"month"'
# Set arrays and booleans
bwrb config edit excluded_directories --json '["Archive","Templates"]'
bwrb config edit mention_exclude_paths --json '["Imports/**"]'
bwrb config edit mention_link_once --json 'true'