Skip to content

AI Setup

typemd integrates with AI through two channels:

  • TUI AI features — auto-describe, auto-tag, and schema explore powered by AI providers (Claude CLI, Ollama, LM Studio, etc.)
  • Skill instructionstmd instructions outputs embedded skills enriched with vault context, usable by any AI tool

The typemd plugin teaches Claude Code how to work with your vault. Add the typemd marketplace and install it:

Terminal window
claude
# Inside Claude Code:
/plugin marketplace add typemd/marketplace
/plugin install typemd@typemd-marketplace

This installs two skills:

SkillWhat it does
vault-guideTeaches AI how to design and manage vaults — CLI commands, type schemas, object format, wiki-links, views, templates
instructions-guideTeaches AI how to use tmd instructions for vault-aware context feeding

The vault-guide skill activates automatically when Claude Code detects a .typemd/ directory.

Add the following to your vault config:

.typemd/config.yaml
ai:
enabled: true

Or use the CLI:

Terminal window
tmd config set ai.enabled true

By default, this uses the Claude CLI. To use a different provider, configure it explicitly:

# .typemd/config.yaml — using Ollama
ai:
enabled: true
default: ollama
providers:
ollama:
type: openai-compatible
base_url: http://localhost:11434
model: qwen3-coder:30b

You can configure multiple providers and switch between them by changing ai.default. See Configuration — AI settings for the full reference.

This enables AI actions in the TUI:

KeyAction
gOpen AI action picker (on an object) — Generate description / Suggest tags
Ctrl+ESchema explore mode (on a type) — AI analyzes objects and suggests schema improvements

tmd instructions outputs embedded skill instructions enriched with your vault’s type definitions. This lets any AI tool understand your vault without manual context gathering.

Terminal window
# List available skills
tmd instructions
# Get explore skill with vault context as JSON
tmd instructions explore
# Save a skill for use in a Claude Code skills directory
tmd instructions explore --skill > .claude/skills/explore/SKILL.md

The JSON output includes your vault’s type summaries (names, emojis, descriptions, properties), so the AI immediately knows your data model. See tmd instructions for full details.

With the typemd plugin installed and AI enabled, you can:

  • Ask Claude Code to analyze your markdown files and suggest type schemas (explore skill)
  • Ask Claude Code to import existing files into your vault (importer skill)
  • Use TUI AI features to auto-generate descriptions and tags for objects
  • Pipe tmd instructions output to any AI tool for vault-aware workflows