Programmatically create and manipulate Obsidian Canvas (.canvas) files using JSON Canvas Spec 1.0. Enables agents to generate visual flowcharts, architecture diagrams, and planning boards. Use when creating or editing visual canvas files.
From obsidian-integrationnpx claudepluginhub richfrem/agent-plugins-skills --plugin obsidian-integrationThis skill is limited to using the following tools:
acceptance-criteria.mdassets/resources/architecture-background.mdassets/resources/kepano-analysis-summary.mdassets/resources/safety-learnings.mdevals/evals.jsonevals/results.tsvfallback-tree.mdobsidian-parser/parser.pyreferences/acceptance-criteria.mdreferences/fallback-tree.mdrequirements.txtscripts/canvas_ops.pyscripts/vault_ops.pyExecutes pre-written implementation plans: critically reviews, follows bite-sized steps exactly, runs verifications, tracks progress with checkpoints, uses git worktrees, stops on blockers.
Guides idea refinement into designs: explores context, asks questions one-by-one, proposes approaches, presents sections for approval, writes/review specs before coding.
Dispatches parallel agents to independently tackle 2+ tasks like separate test failures or subsystems without shared state or dependencies.
This skill requires Python 3.8+ and standard library only. No external packages needed.
To install this skill's dependencies:
pip-compile ./requirements.in
pip install -r ./requirements.txt
See ./requirements.txt for the dependency lockfile (currently empty — standard library only).
Status: Active
Author: Richard Fremmerlid
Domain: Obsidian Integration
Depends On: obsidian-vault-crud (WP06)
Obsidian Canvas files (.canvas) use the JSON Canvas Spec 1.0 to define visual
boards with nodes (text, file references, URLs) connected by directional edges.
This skill lets agents programmatically generate visual planning boards, architecture
diagrams, and execution flowcharts.
A .canvas file is JSON with two top-level arrays:
{
"nodes": [
{"id": "1", "type": "text", "text": "Hello", "x": 0, "y": 0, "width": 250, "height": 60},
{"id": "2", "type": "file", "file": "path/to/note.md", "x": 300, "y": 0, "width": 250, "height": 60}
],
"edges": [
{"id": "e1", "fromNode": "1", "toNode": "2", "fromSide": "right", "toSide": "left"}
]
}
| Type | Required Fields | Purpose |
|---|---|---|
text | text, x, y, width, height | Inline text content |
file | file, x, y, width, height | Reference to a vault note |
link | url, x, y, width, height | External URL |
group | label, x, y, width, height | Visual grouping container |
| Field | Required | Description |
|---|---|---|
fromNode | Yes | Source node ID |
toNode | Yes | Target node ID |
fromSide | No | top, right, bottom, left |
toSide | No | top, right, bottom, left |
label | No | Edge label text |
python ./canvas_ops.py create --file <path.canvas>
python ./canvas_ops.py add-node \
--file <path.canvas> --type text --text "My Node" --x 100 --y 200
python ./canvas_ops.py add-edge \
--file <path.canvas> --from-node id1 --to-node id2
python ./canvas_ops.py read --file <path.canvas>
obsidian-vault-crud atomic write protocol