Get the FREE Ultimate OpenClaw Setup Guide β†’

obsidian-bases

Scanned
npx machina-cli add skill arch3rPro/claude-obsidian-plugin/obsidian-bases --openclaw
Files (1)
SKILL.md
16.1 KB

Obsidian Bases Skill

This skill enables skills-compatible agents to create and edit valid Obsidian Bases (.base files) including views, filters, formulas, and all related configurations.

Overview

Obsidian Bases are YAML-based files that define dynamic views of notes in an Obsidian vault. A Base file can contain multiple views, global filters, formulas, property configurations, and custom summaries.

File Format

Base files use the .base extension and contain valid YAML. They can also be embedded in Markdown code blocks.

Complete Schema

# Global filters apply to ALL views in the base
filters:
  # Can be a single filter string
  # OR a recursive filter object with and/or/not
  and: []
  or: []
  not: []

# Define formula properties that can be used across all views
formulas:
  formula_name: 'expression'

# Configure display names and settings for properties
properties:
  property_name:
    displayName: "Display Name"
  formula.formula_name:
    displayName: "Formula Display Name"
  file.ext:
    displayName: "Extension"

# Define custom summary formulas
summaries:
  custom_summary_name: 'values.mean().round(3)'

# Define one or more views
views:
  - type: table | cards | list | map
    name: "View Name"
    limit: 10                    # Optional: limit results
    groupBy:                     # Optional: group results
      property: property_name
      direction: ASC | DESC
    filters:                     # View-specific filters
      and: []
    order:                       # Properties to display in order
      - file.name
      - property_name
      - formula.formula_name
    summaries:                   # Map properties to summary formulas
      property_name: Average

Filter Syntax

Filters narrow down results. They can be applied globally or per-view.

Filter Structure

# Single filter
filters: 'status == "done"'

# AND - all conditions must be true
filters:
  and:
    - 'status == "done"'
    - 'priority > 3'

# OR - any condition can be true
filters:
  or:
    - 'file.hasTag("book")'
    - 'file.hasTag("article")'

# NOT - exclude matching items
filters:
  not:
    - 'file.hasTag("archived")'

# Nested filters
filters:
  or:
    - file.hasTag("tag")
    - and:
        - file.hasTag("book")
        - file.hasLink("Textbook")
    - not:
        - file.hasTag("book")
        - file.inFolder("Required Reading")

Filter Operators

OperatorDescription
==equals
!=not equal
>greater than
<less than
>=greater than or equal
<=less than or equal
&&logical and
||logical or
<code>!</code>logical not

Properties

Three Types of Properties

  1. Note properties - From frontmatter: note.author or just author
  2. File properties - File metadata: file.name, file.mtime, etc.
  3. Formula properties - Computed values: formula.my_formula

File Properties Reference

PropertyTypeDescription
file.nameStringFile name
file.basenameStringFile name without extension
file.pathStringFull path to file
file.folderStringParent folder path
file.extStringFile extension
file.sizeNumberFile size in bytes
file.ctimeDateCreated time
file.mtimeDateModified time
file.tagsListAll tags in file
file.linksListInternal links in file
file.backlinksListFiles linking to this file
file.embedsListEmbeds in the note
file.propertiesObjectAll frontmatter properties

The this Keyword

  • In main content area: refers to the base file itself
  • When embedded: refers to the embedding file
  • In sidebar: refers to the active file in main content

Formula Syntax

Formulas compute values from properties. Defined in the formulas section.

formulas:
  # Simple arithmetic
  total: "price * quantity"
  
  # Conditional logic
  status_icon: 'if(done, "βœ…", "⏳")'
  
  # String formatting
  formatted_price: 'if(price, price.toFixed(2) + " dollars")'
  
  # Date formatting
  created: 'file.ctime.format("YYYY-MM-DD")'
  
  # Complex expressions
  days_old: '((now() - file.ctime) / 86400000).round(0)'

Functions Reference

Global Functions

FunctionSignatureDescription
date()date(string): dateParse string to date. Format: YYYY-MM-DD HH:mm:ss
duration()duration(string): durationParse duration string
now()now(): dateCurrent date and time
today()today(): dateCurrent date (time = 00:00:00)
if()if(condition, trueResult, falseResult?)Conditional
min()min(n1, n2, ...): numberSmallest number
max()max(n1, n2, ...): numberLargest number
number()number(any): numberConvert to number
link()link(path, display?): LinkCreate a link
list()list(element): ListWrap in list if not already
file()file(path): fileGet file object
image()image(path): imageCreate image for rendering
icon()icon(name): iconLucide icon by name
html()html(string): htmlRender as HTML
escapeHTML()escapeHTML(string): stringEscape HTML characters

Any Type Functions

FunctionSignatureDescription
isTruthy()any.isTruthy(): booleanCoerce to boolean
isType()any.isType(type): booleanCheck type
toString()any.toString(): stringConvert to string

Date Functions & Fields

Fields: date.year, date.month, date.day, date.hour, date.minute, date.second, date.millisecond

FunctionSignatureDescription
date()date.date(): dateRemove time portion
format()date.format(string): stringFormat with Moment.js pattern
time()date.time(): stringGet time as string
relative()date.relative(): stringHuman-readable relative time
isEmpty()date.isEmpty(): booleanAlways false for dates

Date Arithmetic

# Duration units: y/year/years, M/month/months, d/day/days, 
#                 w/week/weeks, h/hour/hours, m/minute/minutes, s/second/seconds

# Add/subtract durations
"date + \"1M\""           # Add 1 month
"date - \"2h\""           # Subtract 2 hours
"now() + \"1 day\""       # Tomorrow
"today() + \"7d\""        # A week from today

# Subtract dates for millisecond difference
"now() - file.ctime"

# Complex duration arithmetic
"now() + (duration('1d') * 2)"

String Functions

Field: string.length

FunctionSignatureDescription
contains()string.contains(value): booleanCheck substring
containsAll()string.containsAll(...values): booleanAll substrings present
containsAny()string.containsAny(...values): booleanAny substring present
startsWith()string.startsWith(query): booleanStarts with query
endsWith()string.endsWith(query): booleanEnds with query
isEmpty()string.isEmpty(): booleanEmpty or not present
lower()string.lower(): stringTo lowercase
title()string.title(): stringTo Title Case
trim()string.trim(): stringRemove whitespace
replace()string.replace(pattern, replacement): stringReplace pattern
repeat()string.repeat(count): stringRepeat string
reverse()string.reverse(): stringReverse string
slice()string.slice(start, end?): stringSubstring
split()string.split(separator, n?): listSplit to list

Number Functions

FunctionSignatureDescription
abs()number.abs(): numberAbsolute value
ceil()number.ceil(): numberRound up
floor()number.floor(): numberRound down
round()number.round(digits?): numberRound to digits
toFixed()number.toFixed(precision): stringFixed-point notation
isEmpty()number.isEmpty(): booleanNot present

List Functions

Field: list.length

FunctionSignatureDescription
contains()list.contains(value): booleanElement exists
containsAll()list.containsAll(...values): booleanAll elements exist
containsAny()list.containsAny(...values): booleanAny element exists
filter()list.filter(expression): listFilter by condition (uses value, index)
map()list.map(expression): listTransform elements (uses value, index)
reduce()list.reduce(expression, initial): anyReduce to single value (uses value, index, acc)
flat()list.flat(): listFlatten nested lists
join()list.join(separator): stringJoin to string
reverse()list.reverse(): listReverse order
slice()list.slice(start, end?): listSublist
sort()list.sort(): listSort ascending
unique()list.unique(): listRemove duplicates
isEmpty()list.isEmpty(): booleanNo elements

File Functions

FunctionSignatureDescription
asLink()file.asLink(display?): LinkConvert to link
hasLink()file.hasLink(otherFile): booleanHas link to file
hasTag()file.hasTag(...tags): booleanHas any of the tags
hasProperty()file.hasProperty(name): booleanHas property
inFolder()file.inFolder(folder): booleanIn folder or subfolder

Link Functions

FunctionSignatureDescription
asFile()link.asFile(): fileGet file object
linksTo()link.linksTo(file): booleanLinks to file

Object Functions

FunctionSignatureDescription
isEmpty()object.isEmpty(): booleanNo properties
keys()object.keys(): listList of keys
values()object.values(): listList of values

Regular Expression Functions

FunctionSignatureDescription
matches()regexp.matches(string): booleanTest if matches

View Types

Table View

views:
  - type: table
    name: "My Table"
    order:
      - file.name
      - status
      - due_date
    summaries:
      price: Sum
      count: Average

Cards View

views:
  - type: cards
    name: "Gallery"
    order:
      - file.name
      - cover_image
      - description

List View

views:
  - type: list
    name: "Simple List"
    order:
      - file.name
      - status

Map View

Requires latitude/longitude properties and the Maps community plugin.

views:
  - type: map
    name: "Locations"
    # Map-specific settings for lat/lng properties

Default Summary Formulas

NameInput TypeDescription
AverageNumberMathematical mean
MinNumberSmallest number
MaxNumberLargest number
SumNumberSum of all numbers
RangeNumberMax - Min
MedianNumberMathematical median
StddevNumberStandard deviation
EarliestDateEarliest date
LatestDateLatest date
RangeDateLatest - Earliest
CheckedBooleanCount of true values
UncheckedBooleanCount of false values
EmptyAnyCount of empty values
FilledAnyCount of non-empty values
UniqueAnyCount of unique values

Complete Examples

Task Tracker Base

filters:
  and:
    - file.hasTag("task")
    - 'file.ext == "md"'

formulas:
  days_until_due: 'if(due, ((date(due) - today()) / 86400000).round(0), "")'
  is_overdue: 'if(due, date(due) < today() && status != "done", false)'
  priority_label: 'if(priority == 1, "πŸ”΄ High", if(priority == 2, "🟑 Medium", "🟒 Low"))'

properties:
  status:
    displayName: Status
  formula.days_until_due:
    displayName: "Days Until Due"
  formula.priority_label:
    displayName: Priority

views:
  - type: table
    name: "Active Tasks"
    filters:
      and:
        - 'status != "done"'
    order:
      - file.name
      - status
      - formula.priority_label
      - due
      - formula.days_until_due
    groupBy:
      property: status
      direction: ASC
    summaries:
      formula.days_until_due: Average

  - type: table
    name: "Completed"
    filters:
      and:
        - 'status == "done"'
    order:
      - file.name
      - completed_date

Reading List Base

filters:
  or:
    - file.hasTag("book")
    - file.hasTag("article")

formulas:
  reading_time: 'if(pages, (pages * 2).toString() + " min", "")'
  status_icon: 'if(status == "reading", "πŸ“–", if(status == "done", "βœ…", "πŸ“š"))'
  year_read: 'if(finished_date, date(finished_date).year, "")'

properties:
  author:
    displayName: Author
  formula.status_icon:
    displayName: ""
  formula.reading_time:
    displayName: "Est. Time"

views:
  - type: cards
    name: "Library"
    order:
      - cover
      - file.name
      - author
      - formula.status_icon
    filters:
      not:
        - 'status == "dropped"'

  - type: table
    name: "Reading List"
    filters:
      and:
        - 'status == "to-read"'
    order:
      - file.name
      - author
      - pages
      - formula.reading_time

Project Notes Base

filters:
  and:
    - file.inFolder("Projects")
    - 'file.ext == "md"'

formulas:
  last_updated: 'file.mtime.relative()'
  link_count: 'file.links.length'
  
summaries:
  avgLinks: 'values.filter(value.isType("number")).mean().round(1)'

properties:
  formula.last_updated:
    displayName: "Updated"
  formula.link_count:
    displayName: "Links"

views:
  - type: table
    name: "All Projects"
    order:
      - file.name
      - status
      - formula.last_updated
      - formula.link_count
    summaries:
      formula.link_count: avgLinks
    groupBy:
      property: status
      direction: ASC

  - type: list
    name: "Quick List"
    order:
      - file.name
      - status

Daily Notes Index

filters:
  and:
    - file.inFolder("Daily Notes")
    - '/^\d{4}-\d{2}-\d{2}$/.matches(file.basename)'

formulas:
  word_estimate: '(file.size / 5).round(0)'
  day_of_week: 'date(file.basename).format("dddd")'

properties:
  formula.day_of_week:
    displayName: "Day"
  formula.word_estimate:
    displayName: "~Words"

views:
  - type: table
    name: "Recent Notes"
    limit: 30
    order:
      - file.name
      - formula.day_of_week
      - formula.word_estimate
      - file.mtime

Embedding Bases

Embed in Markdown files:

![[MyBase.base]]

<!-- Specific view -->
![[MyBase.base#View Name]]

YAML Quoting Rules

  • Use single quotes for formulas containing double quotes: 'if(done, "Yes", "No")'
  • Use double quotes for simple strings: "My View Name"
  • Escape nested quotes properly in complex expressions

Common Patterns

Filter by Tag

filters:
  and:
    - file.hasTag("project")

Filter by Folder

filters:
  and:
    - file.inFolder("Notes")

Filter by Date Range

filters:
  and:
    - 'file.mtime > now() - "7d"'

Filter by Property Value

filters:
  and:
    - 'status == "active"'
    - 'priority >= 3'

Combine Multiple Conditions

filters:
  or:
    - and:
        - file.hasTag("important")
        - 'status != "done"'
    - and:
        - 'priority == 1'
        - 'due != ""'

References

Source

git clone https://github.com/arch3rPro/claude-obsidian-plugin/blob/main/skills/obsidian-bases/SKILL.mdView on GitHub

Overview

Obsidian Bases are YAML-based files that define dynamic, filterable views of notes in an Obsidian vault. A .base file can contain multiple views, global filters, formulas, property configurations, and custom summaries, enabling database-like organization of notes. This skill helps you design, edit, and maintain valid .base files to power consistent note discovery and insights.

How This Skill Works

Bases are YAML-defined configurations (or embedded in Markdown code blocks) that declare filters, formulas, properties, summaries, and views. Each view can be type: table, cards, list, or map, with optional limits, grouping, and per-view filters. When loaded, Obsidian renders these views from the vault’s notes, applying global and view-specific logic to display structured data.

When to Use It

  • You need database-like views of notes using table or card views to organize information.
  • You want global filters that apply across all views within a single base.
  • You require computed values or derived metrics through formulas across properties.
  • You manage multiple views (table, cards, list, map) in one base for different audiences.
  • You’re documenting or embedding Base definitions in Markdown or editing property configurations for consistency.

Quick Start

  1. Step 1: Create a .base YAML file and define global filters, formulas, and properties.
  2. Step 2: Add one or more views (table, cards, list, or map) and configure order and summaries.
  3. Step 3: Save the file in your vault and render it in Obsidian, using code blocks or direct .base references.

Best Practices

  • Start with a clear global filters section to establish baseline scope.
  • Use descriptive displayName values for properties to improve readability.
  • Validate YAML syntax and keep Bases either in .base files or embedded blocks in Markdown.
  • Define a small set of core views first, then progressively add more views and summaries.
  • Test with sample notes, verify ordering and grouping, and iterate on feedback.

Example Use Cases

  • A base for project notes with a table view showing status, assignee, and due date.
  • A base for research articles with a cards view displaying title, tags, and key findings.
  • A base for tasks with a list view and a computed priority from due dates.
  • A base for a knowledge graph using a map view showing file links and backlinks as properties.
  • A base for blog drafts with summaries and a filter to show only drafts.

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers β†—