bwrb list
List notes matching filter criteria with flexible output formats.
Synopsis
Section titled “Synopsis”bwrb list [options] [positional]The positional argument is auto-detected as type, path (contains /), or where expression (contains operators).
Options
Section titled “Options”Targeting
Section titled “Targeting”| Option | Description |
|---|---|
-t, --type <type> | Filter by type path (e.g., idea, objective/task) |
-p, --path <glob> | Filter by file path glob (e.g., Projects/**, Ideas/) |
-w, --where <expr> | Filter with expression (repeatable, ANDed together) |
-b, --body <query> | Filter by body content search |
Output
Section titled “Output”| Option | Description |
|---|---|
-o, --output <format> | Output format: text, paths, tree, link, json |
--fields <fields> | Show frontmatter fields in a table (comma-separated) |
-L, --depth <n> | Limit tree depth |
Actions
Section titled “Actions”| Option | Description |
|---|---|
--open | Open the first result (or pick interactively) |
--app <mode> | How to open: system, editor, visual, obsidian, print |
--save-as <name> | Save this query as a dashboard |
--force | Overwrite existing dashboard when using --save-as |
Output Formats
Section titled “Output Formats”| Format | Description |
|---|---|
text | Note names (default) |
paths | Vault-relative file paths |
tree | Hierarchical tree view |
link | Wikilinks ([[Note Name]]) |
json | Full JSON data |
Examples
Section titled “Examples”Basic Listing
Section titled “Basic Listing”# List all notes of a typebwrb list taskbwrb list objective/milestone
# With field columnsbwrb list task --fields=status,priorityFiltering
Section titled “Filtering”# By frontmatter valuesbwrb list --type task --where "status == 'in-progress'"bwrb list --type task --where "priority < 3 && !isEmpty(deadline)"
# By datebwrb list --type task --where "deadline < today() + '7d'"
# By body contentbwrb list --body "TODO" --where "status == 'draft'"
# By pathbwrb list --path "Projects/**" --body "TODO"Hierarchy Functions
Section titled “Hierarchy Functions”For recursive types with parent-child relationships:
# Root notes onlybwrb list --type task --where "isRoot()"
# Direct childrenbwrb list --type task --where "isChildOf('[[Epic]]')"
# All descendants (with depth limit)bwrb list --type task --where "isDescendantOf('[[Q1 Goals]]')" --depth 2Output Formats
Section titled “Output Formats”bwrb list --type task --output jsonbwrb list --type task --output pathsbwrb list --type task --output link # [[Task 1]], [[Task 2]], ...bwrb list --type task --output tree # Hierarchical displayOpen from Results
Section titled “Open from Results”bwrb list --type task --open # Pick from tasks and openbwrb list --type task --where "status=inbox" --openSave as Dashboard
Section titled “Save as Dashboard”bwrb list --type task --where "status='active'" --save-as "active-tasks"bwrb list --type task --output tree --save-as "task-tree" --forceShell Note
Section titled “Shell Note”In zsh, use single quotes for expressions with ! to avoid history expansion:
bwrb list --type task --where '!isEmpty(deadline)'See Also
Section titled “See Also”- Targeting Model — Full selector reference
- bwrb dashboard — Run saved queries
- bwrb search — Interactive search with picker