Trellis

Trellis

English | 한국어

Trellis uses hierarchical managed tags to keep filename parts consistent across many notes. Tags remain the source of truth, and renames go through Obsidian so internal links can update with the file.

tag   #projects/PRJ/01/DOC/01
file  PRJ01DOC01-meeting-notes.md

tag   #projects/PRJ/01/DOC/02
file  PRJ01DOC02-meeting-notes.md

Trellis does not require every note to use managed tags. Notes outside the registered namespaces keep their existing tags and filenames.

Why use Trellis?

A filename prefix can make a large vault easier to scan, but maintaining the same structure by hand across many notes is slow and error-prone. Trellis lets you describe that structure once and project it from frontmatter tags.

frontmatter tags → filename structure → Obsidian rename → internal links updated

This keeps the structured part of a filename consistent while leaving an optional human-readable title under direct user control.

Core model

• Managed tag — a registered hierarchical tag namespace, such as #projects/... or #areas/....
• Tag slot — a filename part projected from one managed tag.
• General slot — the optional free title kept in the filename. A structure can contain at most one general slot.
• Boundary — the symbol, one space, or direct join between populated slots.
• Filename structure — the ordered list of slots and boundaries applied across managed notes.

Managed tag registration and filename projection are separate. A managed tag can appear in the Trellis sidebar without appearing in a filename, and each definition can be shown, hidden, or archived independently.

Filename structures

The default structure is one tag slot followed by one general slot:

[projects tag] - [general title]
PRJ01DOC01-meeting-notes

You can also combine several optional tag slots:

#projects/PRJ/01 + #areas/ENG/02
→ PRJ01-project-overview-ENG02

Each note only needs the managed tags that apply to it. Empty slots and their unused boundaries collapse automatically.

Per tag slot, you can configure:

• the managed tag definition used as its source;
• how hierarchy is displayed: hidden, a preset, or safe custom punctuation;
• no wrapper, round parentheses, or a safe custom wrapper;
• whether underscores stay unchanged or appear as spaces in the filename.

The underscore option changes only the projected filename text:

stored tag      #topics/design_system
filename text   design system

Per boundary, you can choose:

• a symbol with optional spacing on either side;
• one plain space;
• no separator.

Trellis rejects structures that cannot be parsed safely, would create duplicate filenames, or use characters that are unsafe across supported platforms.

Main features

• One-way filename sync — frontmatter managed tags update filename slots; editing a projected filename part does not rewrite the tag.
• Pause and review — pause filename sync while editing tags, then review the exact drift and collisions before applying the filenames.
• Tag tree sidebar — browse managed hierarchies, open notes, create notes, find the current note, sort, and expand or collapse branches.
• Independent sidebar visibility — show several managed tag definitions, hide individual definitions, or hide selected branches.
• Subtree changes — preview and move a managed tag with all descendants, including reviewed transfers between definitions.
• Import existing filenames — derive managed tag candidates from compatible filenames through a dry run before writing.
• Duplicate cleanup — review notes carrying more than one value for a filename-bearing managed definition and keep the intended value.
• Value suggestions — optionally suggest sequences, dates, timestamps, or alternating alphabet and number segments when creating notes.
• Properties labels — shorten managed tag labels in Obsidian Properties without changing the stored tags.
• Inventory — inspect usage counts, combinations, inline-tag warnings, filename drift, and exact collisions per managed definition.

Safe writes and completion

Trellis treats filename and tag changes as managed write operations.

• Live sync, automation, and bulk work share one write owner.
• Repeated metadata events for the same note are coalesced before filename sync.
• Bulk changes show the affected notes before apply and retain supported undo records.
• Renames share the same portability, collision, re-entry, and link-safe guard.
• A failed or cancelled batch either rolls back the completed prefix or retains an exact undo record, depending on the command, and reports anything that still needs review.
• A recorded bulk or automation write that was running when Obsidian stopped is reported as interrupted on the next load instead of being treated as complete.

Renames use Obsidian's file manager and follow Obsidian's Automatically update internal links setting.

Quick start

1. Install and enable Trellis.
2. Open Settings → Trellis → Filename & tags.
3. Register a managed tag namespace, for example projects.
4. Add that managed tag to a tag slot in the filename structure.
5. Add a frontmatter tag such as projects/PRJ/01/DOC/01 to a note.
6. Review any bulk preview before applying a vault-wide change.

Example frontmatter:

---
tags:
  - projects/PRJ/01/DOC/01
---

Frontmatter tags are the management source. Inline tags are not rewritten and are reported separately when they overlap a managed namespace.

Automation for tools and AI

Trellis exposes a guarded in-process surface for tools that already run inside Obsidian:

describe / inspectNote → planChange → applyChange → awaitIdle

Plans are rejected if the note, tags, filename structure, or target path changed after inspection. Callers can query operation status and must treat an attention report as unfinished review even when Trellis is otherwise idle.

Trellis opens no network, REST, URI, or MCP endpoint. See Guarded automation for the request and result contracts.

Current boundaries

• Trellis manages frontmatter tags; other properties are not filename sources.
• Each managed definition is single-valued per note for filename projection.
• A filename structure supports multiple tag slots and at most one free general slot.
• Trellis renames note files, not matching folders or Folder Note pairs.
• Multi-value classification, note semantics, folder organization, Git history, and rules for assigning identifiers remain the user's responsibility.

These boundaries keep Trellis useful in different vaults without imposing one knowledge-management system.

Installation

Community plugins

In Obsidian, open Settings → Community plugins → Browse, search for Trellis, then install and enable it.

Manual installation

Download main.js, manifest.json, and styles.css from a matching GitHub release, then place them in:

your-vault/.obsidian/plugins/trellis/

Enable Trellis from Obsidian's Community plugins settings.

Compatibility, privacy, and safety

• Requires Obsidian 1.8.7 or newer.
• Supports desktop and mobile.
• Runs locally through Obsidian's public APIs.
• Makes no network requests and collects no telemetry.
• Does not access files outside the current vault.

Filename and tag migrations can affect many notes. Review the preview and keep a normal vault backup before large changes.

Development

npm ci
npm run lint
npm run build
npm test

Pure filename-structure logic lives in src/tagkey.ts. Persisted settings and operation tracking live in src/settings-model.ts and src/operation-state.ts. Obsidian integration lives in src/main.ts.

See CONTRIBUTING.md for the development and release workflow.

License

MIT