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 instructions —
tmd instructionsoutputs embedded skills enriched with vault context, usable by any AI tool
Prerequisites
Section titled “Prerequisites”- typemd installed with a vault initialized
- An AI provider: Claude Code, Ollama, LM Studio, or any OpenAI-compatible API
1. Install the typemd plugin
Section titled “1. Install the typemd plugin”The typemd plugin teaches Claude Code how to work with your vault. Add the typemd marketplace and install it:
claude# Inside Claude Code:/plugin marketplace add typemd/marketplace/plugin install typemd@typemd-marketplaceThis installs two skills:
| Skill | What it does |
|---|---|
| vault-guide | Teaches AI how to design and manage vaults — CLI commands, type schemas, object format, wiki-links, views, templates |
| instructions-guide | Teaches AI how to use tmd instructions for vault-aware context feeding |
The vault-guide skill activates automatically when Claude Code detects a .typemd/ directory.
2. Enable TUI AI features
Section titled “2. Enable TUI AI features”Add the following to your vault config:
ai: enabled: trueOr use the CLI:
tmd config set ai.enabled trueBy default, this uses the Claude CLI. To use a different provider, configure it explicitly:
# .typemd/config.yaml — using Ollamaai: enabled: true default: ollama providers: ollama: type: openai-compatible base_url: http://localhost:11434 model: qwen3-coder:30bYou 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:
| Key | Action |
|---|---|
g | Open AI action picker (on an object) — Generate description / Suggest tags |
Ctrl+E | Schema explore mode (on a type) — AI analyzes objects and suggests schema improvements |
3. Use skill instructions
Section titled “3. Use skill instructions”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.
# List available skillstmd instructions
# Get explore skill with vault context as JSONtmd instructions explore
# Save a skill for use in a Claude Code skills directorytmd instructions explore --skill > .claude/skills/explore/SKILL.mdThe 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.
What’s next
Section titled “What’s next”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 instructionsoutput to any AI tool for vault-aware workflows