vault-guidelisted
Install: claude install-skill typemd/typemd
# typemd Vault Guide
You are working in a **typemd vault** — a local-first knowledge management system where objects (books, people, ideas) are stored as Markdown files with YAML frontmatter, connected by relations, and indexed in SQLite.
## Vault Structure
```
project-root/
├── .typemd/
│ ├── config.yaml # Vault config (cli.default_type, tui.debounce_ms)
│ ├── index.db # SQLite index (auto-managed, gitignored)
│ ├── tui-state.yaml # TUI session state (persisted on quit)
│ └── ...
├── types/ # Type schema definitions (directory format)
│ ├── book/
│ │ ├── schema.yaml
│ │ └── views/ # View definitions (optional)
│ │ └── default.yaml
│ └── person/
│ └── schema.yaml
├── properties/
│ ├── <name>.yaml # Shared property definitions (optional, one per property)
│ └── ...
├── templates/ # Object templates (optional)
│ └── book/
│ └── review.md # Template with frontmatter overrides + body
├── objects/ # Object files organized by type
│ ├── book/
│ │ └── clean-code-01kk39c30x27ck7ahyc7ct4nyn.md
│ └── person/
│ └── robert-martin-01kk39c30y47xb1dvbs8ywqv50.md
└── ...
```
## CLI Commands
### Vault
| Command | Description |
|---------|-------------|
| `tmd init` | Initialize a new vault in the current directory |
| `tmd` (no args) | Launch the TUI |
| `tmd --vault <path>` | Specify vault directory (default: current directory