napkin

name	napkin
description	Read, create, search, and manage notes in Obsidian vaults using the napkin CLI. Works directly on markdown files and canvas files — no Obsidian app required. Use when the user asks to interact with their Obsidian vault, manage notes, search vault content, work with tasks, tags, properties, daily notes, templates, bases, bookmarks, aliases, or canvas files from the command line.

napkin

CLI for Obsidian vaults. Operates directly on markdown files — no Obsidian app, no Electron, no Catalyst license.

Install: npm install -g napkin-ai

Vault Structure

.napkin/ is the config directory. Content lives at the vault root alongside it:

my-vault/                   # Vault root
  .napkin/                  # Config only
    config.json             # Unified config (syncs to .obsidian/)
    .obsidian/              # Obsidian compatibility (auto-generated)
  NAPKIN.md                 # Context note (Level 0)
  Templates/                # Note templates
  decisions/                # Template-defined directories
  architecture/
  guides/

Progressive Disclosure

napkin reveals information gradually — overview first, then search, then read:

Level	Command	What it does
L0	NAPKIN.md	Project context note
L1	napkin overview	L0 + vault map with TF-IDF keywords per folder
L2	napkin search <query>	BM25 + backlinks + recency ranked results with snippets
L3	napkin read <file>	Full file content

Workflow: overview → search → read

Initialize

napkin init                              # Initialize empty vault
napkin init --template coding            # Scaffold with template
napkin init --template company           # people/, projects/, runbooks/, infrastructure/
napkin init --template product           # features/, roadmap/, research/, specs/, releases/
napkin init --template personal          # people/, projects/, areas/, references/
napkin init --template research          # papers/, concepts/, questions/, experiments/
napkin init --list                       # List available templates
napkin init --path /some/dir             # Initialize in specific directory

Each template includes directory structure, _about.md files, Obsidian note templates, and a NAPKIN.md skeleton.

Overview & Graph

napkin overview                          # Vault map with TF-IDF keywords per folder
napkin overview --depth 3                # Limit folder depth
napkin overview --keywords 5             # Max keywords per folder
napkin graph                             # Interactive force-directed vault graph

Config

napkin config show                       # Show full config
napkin config get --key search.limit     # Get a value
napkin config set --key search.limit --value 50

Syntax

Commands accept positional arguments. Quote values with spaces:

napkin create "My Note" "Hello world"
napkin append "My Note" "More text"
echo "piped content" | napkin append "My Note"

Flags also work (backward compatible):

napkin create --name "My Note" --content "Hello world"

Global flags

Flag	Description
--json	Output as JSON (use this for programmatic access)
-q, --quiet	Suppress output
--vault <path>	Vault path (default: auto-detect by walking up from cwd looking for .napkin/)
--copy	Copy output to clipboard

File targeting

• Positional <file> or --file <name> — resolves like a wikilink (name only, no path or extension needed)
• --path <path> — exact path from vault root, e.g. Projects/note.md

Commands

Vault

napkin vault                                # Vault info (name, path, files, folders, size)
napkin version                              # CLI version

Files & folders — napkin file

napkin file info <name>                     # File info (path, size, dates)
napkin file list                            # List all files
napkin file list --ext md                   # Filter by extension
napkin file list --folder Projects          # Filter by folder
napkin file list --total                    # Count files
napkin file folder <path>                   # Folder info (files, folders, size)
napkin file folder <path> --info files      # Just the file count
napkin file folders                         # List all folders
napkin file folders --total                 # Count folders

Read & write

napkin read "Note"                          # Read file contents
napkin create "Note" "# Hello"              # Create with content
napkin create "Note" --path "Projects" --template "Meeting Note"
napkin append "Note" "New line at end"
napkin prepend "Note" "New line after frontmatter"
napkin move "Note" Archive
napkin rename "Note" "Renamed Note"
napkin delete "Note"                        # Move to .trash
napkin delete "Note" --permanent            # Delete permanently

Daily notes — napkin daily

Reads config from .napkin/.obsidian/daily-notes.json (folder, format, template).

napkin daily today                          # Create today's daily note (from template if configured)
napkin daily path                           # Print daily note path
napkin daily read                           # Print daily note contents
napkin daily append "- [ ] Buy groceries"
napkin daily prepend "## Morning"

Search

Ranked search using BM25 + backlinks + recency. Returns snippets with context by default.

napkin search "meeting"                     # Find files matching text
napkin search --query "meeting"             # Same, using flag
napkin search "TODO" --path Projects        # Limit to folder
napkin search "bug" --total                 # Count matches
napkin search "deploy" --limit 5            # Top 5 results
napkin search "TODO" --no-snippets          # Files only, no snippets
napkin search "deploy" --snippet-lines 3    # Context lines around matches
napkin search "auth" --score               # Include relevance score

Tasks — napkin task

napkin task list                            # List all tasks
napkin task list --todo                     # Incomplete only
napkin task list --done                     # Completed only
napkin task list --daily                    # Today's daily note tasks
napkin task list --file "Project A"         # Tasks in specific file
napkin task list --verbose                  # Group by file with line numbers
napkin task list --total                    # Count tasks
napkin task show --file "note" --line 3     # Show task info
napkin task show --file "note" --line 3 --toggle  # Toggle ✓/○
napkin task show --file "note" --line 3 --done    # Mark done
napkin task show --ref "note.md:3" --todo         # Mark todo (file:line shorthand)

Tags — napkin tag

napkin tag list                             # List all tags
napkin tag list --counts                    # With occurrence counts
napkin tag list --sort count                # Sort by frequency
napkin tag info --name "project"            # Tag info (count)
napkin tag info --name "project" --verbose  # With file list
napkin tag aliases                          # List all aliases in vault
napkin tag aliases --file "note"            # Aliases for a file
napkin tag aliases --total                  # Count aliases

Properties — napkin property

napkin property list                        # List all property names in vault
napkin property list --file "note"          # Properties for a specific file
napkin property list --counts               # With occurrence counts
napkin property read --file "note" --name title
napkin property set --file "note" --name status --value done
napkin property remove --file "note" --name status

Links — napkin link

napkin link back --file "note"              # Files linking TO this file
napkin link out --file "note"               # Outgoing links FROM this file
napkin link unresolved                      # Broken links (target doesn't exist)
napkin link orphans                         # Files with no incoming links
napkin link deadends                        # Files with no outgoing links

Outline

napkin file outline "note"                  # Heading tree
napkin file outline "note" --format md      # Markdown list
napkin file outline "note" --format json    # JSON array

Templates — napkin template

napkin template list                        # List templates
napkin template read --name "Daily Note"    # Read template content
napkin template read --name "Meeting" --resolve --title "Standup"  # Resolve variables
napkin template insert --file "note" --name "Template"  # Insert template into file

Bookmarks — napkin bookmark

napkin bookmark list                        # List bookmarks
napkin bookmark list --total                # Count bookmarks
napkin bookmark add --file "note"           # Bookmark a file
napkin bookmark add --folder "Projects"     # Bookmark a folder
napkin bookmark add --search "TODO"         # Bookmark a search
napkin bookmark add --url "https://example.com" --title "Example"

Bases — napkin base

Query vault files using Obsidian Bases .base files (YAML-defined filters over frontmatter properties, powered by SQLite in-memory).

napkin base list                            # List .base files
napkin base views --file "projects"         # List views in a base
napkin base query --file "projects"         # Query default view
napkin base query --file "projects" --view "Active"  # Query named view
napkin base query --file "projects" --format paths   # Just file paths
napkin base query --file "projects" --format csv     # CSV output
napkin base create --file "projects" --name "New Item"  # Create item in base

Canvas — napkin canvas

Read and write JSON Canvas files (.canvas) — nodes, edges, groups.

napkin canvas list                          # List .canvas files
napkin canvas list --total                  # Count canvases
napkin canvas read --file "Board"           # Dump canvas (nodes + edges)
napkin canvas nodes --file "Board"          # List all nodes
napkin canvas nodes --file "Board" --type text  # Filter by type
napkin canvas create --file "Board"         # Create empty canvas
napkin canvas create --file "Board" --path "Projects"
napkin canvas add-node --file "Board" --type text --text "# Hello"
napkin canvas add-node --file "Board" --type file --note-file "Notes/note.md"
napkin canvas add-node --file "Board" --type link --url "https://example.com"
napkin canvas add-node --file "Board" --type group --label "My Group"
napkin canvas add-node --file "Board" --type text --text "Positioned" --x 100 --y 200
napkin canvas add-edge --file "Board" --from abc1 --to def2 --label "relates to"
napkin canvas remove-node --file "Board" --id abc1  # Removes node + connected edges

Node IDs are 16-char hex. --from/--to/--id accept ID prefixes for convenience. Node types: text, file, link, group. Colors: 1-6 or hex. New nodes auto-position to the right of existing content.

Word count

napkin file wordcount "note"                # Words + characters
napkin file wordcount "note" --words        # Words only
napkin file wordcount "note" --characters   # Characters only

Agent onboarding

napkin onboard                              # Print instructions for CLAUDE.md/AGENTS.md

JSON output

Every command supports --json. Always use --json for programmatic access:

napkin task list --todo --json
# {"tasks": [{"text": "Buy groceries", "done": false, "file": "Daily/2024-01-15.md", "line": 5}, ...]}

napkin search "deploy" --json
# {"files": ["Projects/Deploy Guide.md", "Notes/CI-CD.md"]}

napkin property read --file "note" --name status --json
# {"value": "done"}

Common workflows

Morning standup prep

napkin daily read --json                    # What did I write yesterday?
napkin task list --todo --json              # What's pending?
napkin search "blocker" --json              # Any blockers?

Project overview

napkin file list --folder Projects --json   # List project files
napkin tag list --counts --json             # Tag distribution
napkin link orphans --json                  # Forgotten files
napkin link unresolved --json               # Broken links to fix

Note management

napkin create --name "Meeting Notes" --template "Meeting Note" --path "Meetings"
napkin property set --file "Meeting Notes" --name attendees --value "Alice, Bob"
napkin append --file "Meeting Notes" --content "- [ ] Follow up on deployment"

---

Obsidian Markdown Reference

napkin operates on Obsidian Flavored Markdown files. This section covers the syntax for creating valid content.

Properties (frontmatter)

YAML frontmatter at the start of a note:

---
title: My Note
date: 2024-01-15
tags:
  - project
  - important
aliases:
  - My Note
  - Alternative Name
cssclasses:
  - custom-class
status: in-progress
rating: 4.5
completed: false
---

Property types

Type	Example
Text	title: My Title
Number	rating: 4.5
Checkbox	completed: true
Date	date: 2024-01-15
Date & Time	due: 2024-01-15T14:30:00
List	tags: [one, two] or YAML list
Links	related: "[[Other Note]]"

Default properties: tags, aliases, cssclasses

Internal links (wikilinks)

[[Note Name]]                    Link to note
[[Note Name|Display Text]]       Custom display text
[[Note Name#Heading]]            Link to heading
[[Note Name#^block-id]]          Link to block
[[#Heading in same note]]        Same-file heading link

Embeds

![[Note Name]]                   Embed entire note
![[Note Name#Heading]]           Embed section
![[image.png]]                   Embed image
![[image.png|300]]               Image with width
![[document.pdf]]                Embed PDF
![[document.pdf#page=3]]         PDF at page

Tags

#tag
#nested/tag
#tag-with-dashes

# In frontmatter:
tags:
  - tag1
  - nested/tag2

Tags can contain letters, numbers (not first), underscores, hyphens, forward slashes.

Task lists

- [ ] Incomplete task
- [x] Completed task
- [ ] Parent task
  - [ ] Subtask
  - [x] Done subtask

Callouts

> [!note]
> This is a note callout.

> [!warning] Custom Title
> Warning with custom title.

> [!faq]- Collapsed by default
> Hidden until expanded.

> [!tip]+ Expanded by default
> Visible but collapsible.

Callout types: note, abstract/summary/tldr, info, todo, tip/hint/important, success/check/done, question/help/faq, warning/caution/attention, failure/fail/missing, danger/error, bug, example, quote/cite

Text formatting

Style	Syntax
Bold	**text**
Italic	*text*
Bold + Italic	***text***
Strikethrough	~~text~~
Highlight	==text==
Inline code	`code`

Code blocks

```javascript
function hello() {
  console.log("Hello");
}
```

Math (LaTeX)

Inline: $e^{i\pi} + 1 = 0$

Block:
$$
\sum_{i=1}^{n} x_i
$$

Block references

This paragraph can be linked to. ^my-block-id

Link to it: [[Note#^my-block-id]]
Embed it: ![[Note#^my-block-id]]

Comments

This is visible %%but this is hidden%% text.

%%
This entire block is hidden.
%%

---

Bases Reference

Bases are YAML-defined views that query vault files using their frontmatter properties. Saved as .base files.

Structure

filters:
  and:
    - file.hasTag("project")
    - 'status != "done"'
formulas:
  days_left: '(date(due) - today()).days'
properties:
  status:
    displayName: Status
views:
  - type: table
    name: "Active"
    order:
      - file.name
      - status
    limit: 20

Filters

# Single filter
filters:
  file.hasTag("project")

# AND
filters:
  and:
    - file.hasTag("project")
    - 'status != "done"'

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

# NOT
filters:
  not:
    - file.hasTag("archived")

# Nested
filters:
  or:
    - file.hasTag("urgent")
    - and:
        - file.hasTag("project")
        - 'priority >= 3'

Filter operators

Operator	Description
==	equals
!=	not equal
>	greater than
<	less than
>=	greater than or equal
<=	less than or equal

File functions for filters

Function	Description
file.hasTag("tag1", "tag2")	Has any of the tags (includes nested)
file.hasLink("Note")	Has link to note
file.hasProperty("name")	Has frontmatter property
file.inFolder("Projects")	In folder or subfolder

File properties

Property	Type	Description
file.name	String	File name
file.basename	String	Name without extension
file.path	String	Full path from vault root
file.folder	String	Parent folder path
file.ext	String	File extension
file.size	Number	Size in bytes
file.ctime	Date	Created time
file.mtime	Date	Modified time
file.tags	List	All tags
file.links	List	Internal links

Note properties

Frontmatter properties accessed as note.property or just property:

filters:
  and:
    - 'status == "active"'        # shorthand
    - 'note.priority >= 3'        # explicit

Formulas

formulas:
  total: "price * quantity"
  status_icon: 'if(done, "✅", "⏳")'
  formatted_price: 'if(price, price.toFixed(2) + " dollars")'
  created: 'file.ctime.format("YYYY-MM-DD")'
  days_old: '(now() - file.ctime).days'
  days_until_due: 'if(due_date, (date(due_date) - today()).days, "")'

Global functions

Function	Description
date(string)	Parse date (YYYY-MM-DD HH:mm:ss)
now()	Current datetime
today()	Current date (time = 00:00:00)
if(cond, true, false?)	Conditional
min(n1, n2, ...)	Smallest number
max(n1, n2, ...)	Largest number
number(any)	Convert to number
link(path, display?)	Create link
list(element)	Wrap in list

Date arithmetic

"date + \"1M\""              # Add 1 month
"now() + \"1 day\""          # Tomorrow
"today() + \"7d\""           # Week from today
"(now() - file.ctime).days"  # Days since created

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

String functions

contains(), startsWith(), endsWith(), lower(), trim(), replace(), split(), slice(), isEmpty(), .length

Number functions

abs(), ceil(), floor(), round(digits?), toFixed(precision)

List functions

contains(), filter(), map(), join(), sort(), unique(), flat(), isEmpty(), .length

Views

views:
  - type: table           # table, list, cards, map
    name: "My View"
    limit: 10
    order:
      - file.name
      - status
      - due_date
    filters:              # View-level filters (AND'd with global)
      'status != "done"'
    groupBy:
      property: status
      direction: ASC      # or DESC
    summaries:
      price: Sum
      count: Average

Summary functions

Name	Input	Description
Average	Number	Mean
Min	Number	Smallest
Max	Number	Largest
Sum	Number	Sum
Range	Number	Max - Min
Median	Number	Median
Earliest	Date	Earliest date
Latest	Date	Latest date
Empty	Any	Count of empty values
Filled	Any	Count of non-empty values
Unique	Any	Count of unique values

Example: Task tracker

filters:
  and:
    - file.hasTag("task")
    - 'file.ext == "md"'
formulas:
  days_until_due: 'if(due, (date(due) - today()).days, "")'
  priority_label: 'if(priority == 1, "🔴 High", if(priority == 2, "🟡 Medium", "🟢 Low"))'
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

---

JSON Canvas Reference

Canvas files (.canvas) are JSON following the JSON Canvas Spec 1.0.

{
  "nodes": [
    {"id": "aabb11223344", "type": "text", "x": 0, "y": 0, "width": 300, "height": 150, "text": "# Hello\nMarkdown content"},
    {"id": "ccdd55667788", "type": "file", "x": 400, "y": 0, "width": 300, "height": 200, "file": 
                 
                   
  
   
               
  

Node types

Type	Required fields	Description
text	text	Markdown content
file	file, optional subpath	Reference to vault file
link	url	External URL
group	optional label, background, backgroundStyle	Visual container

Common fields

All nodes: id (16-char hex), type, x, y, width, height, optional color (1-6 or hex). Edges: id, fromNode, toNode, optional fromSide/toSide (top/right/bottom/left), fromEnd/toEnd (none/arrow), label, color.

---

Example: Project notes

filters:
  and:
    - file.inFolder("Projects")
    - 'file.ext == "md"'
formulas:
  last_updated: 'file.mtime.relative()'
  link_count: 'file.links.length'
views:
  - type: table
    name: "All Projects"
    order:
      - file.name
      - status
      - formula.last_updated
      - formula.link_count
    groupBy:
      property: status
      direction: ASC