Reference
This reference lists the files, commands, skills, and safety boundaries used by Knowlery.
Plugin Metadata
| Field | Current value |
|---|---|
| Plugin ID | knowlery |
| Minimum Obsidian app version | 1.12.2 |
| Desktop-only manifest flag | true |
| Main bundle | main.js |
| Stylesheet | styles.css |
Dashboard and Settings Surfaces
| Surface | Purpose |
|---|---|
| Dashboard home | Today's move, suggested moves, Knowledge health, This note, Recent activity, This week, and Bundles |
| Share knowledge bundle | Seed picking, graph-closure review, risk scan, and bundle export |
| Install knowledge bundle | Manifest and conformance preview, install, and installed-bundle list |
| Move drill-ins | Full suggested-move list and individual move prompts |
| Activity drill-in | Full recent activity list |
| Knowledge health drill-in | Stale pages, never-compiled notes, dangling sources, and the re-cook prompt; optional Jev ranking of never-compiled notes |
| Settings: Diagnostics | Vault health, content stats, configuration integrity, diagnosis, and the Indexing list of skipped directories (with reasons) |
| Settings: Rules & schema | Agent rules, schema shortcuts, config maintenance, and the reference / ignored directory lists |
| Settings: Skills | Built-in, registry, custom, and disabled skill management |
Created Files and Folders
| Path | Created by | Notes |
|---|---|---|
KNOWLEDGE.md | Setup | Your description of the knowledge base; user-owned |
SCHEMA.md | Setup | Knowledge taxonomy and page conventions |
INDEX.base | Setup | Bases index |
entities/ | Setup | Agent-maintained entity pages |
concepts/ | Setup | Agent-maintained concept pages |
comparisons/ | Setup | Agent-maintained comparison pages |
queries/ | Setup | Agent-maintained research threads |
.knowlery/manifest.json | Setup | Setup state |
.agents/skills/ | Setup | Canonical skills |
.agents/rules/ | Setup | Rules, for every platform (inlined into AGENTS.md, imported by .claude/CLAUDE.md) |
.claude/skills/ | Setup | Mirrored built-in skills for Claude Code |
AGENTS.md | Setup | Entry file for Codex, OpenCode, Cursor…: KNOWLEDGE.md + Knowlery operating rules + rules copied into a managed block |
.claude/CLAUDE.md | Setup | Entry file for Claude Code: @../KNOWLEDGE.md, operating rules, one @ import per rule (managed block) |
skills-lock.json | Setup | Skill lock state |
.knowlery/activity/ | Activity logging | Private activity receipts |
.knowlery/reports/ | Weekly summary | Local HTML report output |
.knowlery/requests/ | Daily polish | Daily review requests |
.knowlery/reviews/ | Daily polish | Daily review results |
.knowlery/exports/ | Share knowledge bundle | Compiled bundle output (optionally zipped) |
.knowlery/export-scope.json | Share knowledge bundle | Saved per-topic review scope |
Library/<bundle-id>/ | Install knowledge bundle | Installed bundle contents |
.knowlery/bundles.json | Install knowledge bundle | Installed bundle registry |
.knowlery/bin/query.mjs | Setup, refreshed on sync | Offline retrieval and staleness script (node .knowlery/bin/query.mjs) |
.knowlery/config.json | Reference / ignored directories | referenceDirs (queryable, never uncooked) and ignoreDirs (never scanned); schemaVersion 1 |
.knowlery/triage.json | Jev cook triage | Jev scores per never-compiled note (path, score, suggested target, mtime); never the key or note text |
Built-In Skills
| Name | Kind | Purpose |
|---|---|---|
cook | knowledge | Digest notes into knowledge pages and keep SCHEMA.md aligned |
ask | knowledge | Answer questions from vault content |
explore | knowledge | Trace idea timelines and bridges |
challenge | knowledge | Pressure-test beliefs and drift |
ideas | knowledge | Generate ideas from vault content |
audit | knowledge | Scan agent-maintained directories for structural health issues |
organize | knowledge | Suggest structure improvements |
obsidian-cli | tooling | Use Obsidian CLI patterns |
obsidian-markdown | tooling | Write Obsidian markdown |
obsidian-bases | tooling | Work with Bases files |
json-canvas | tooling | Work with JSON Canvas |
defuddle | tooling | Extract clean markdown from web pages |
vault-conventions | tooling | Enforce vault naming conventions |
knowlery-cli | tooling | Operate the knowledge base with the standalone knowlery CLI |
knowlery-mcp | tooling | Work the knowledge base through the Knowlery MCP tools |
Settings Sections
| Section | What it controls |
|---|---|
| General | Knowledge base name, display language (Follow Obsidian / English / 中文), Node.js path, and the KB-registry toggle |
| Platform | Claude Code / OpenCode switching |
| Activity | Activity logging and activity ledger rule |
| Knowledge bundle defaults | Creator name, creator URL, and default license for exported bundles |
| Jev cook triage (optional) | TypeSafe AI API key; unlocks Jev ranking in Knowledge health and an optional background-scoring toggle (off by default). Scores persist in .knowlery/triage.json; knowlery stale, knowlery triage and MCP stale read the key from here (or TYPESAFE_API_KEY) and score on their own. Empty by default; nothing else depends on it |
| Maintenance | Regenerate agent config and re-initialize vault |
| Advanced | Diagnostics, rules & schema, and the skills library |
Default Rule Templates
Knowlery includes default rule templates for:
| Rule | Purpose |
|---|---|
| Citation required | Require wikilink citations for vault answers |
| Language preference | Match the user's language |
| Domain context | Describe the vault's domain |
Commands Registered in Obsidian
Knowlery registers command palette actions for:
- Opening the dashboard.
- Initializing the vault.
- Running vault diagnosis.
- Adding a reflection.
- Sharing a knowledge bundle.
- Installing a knowledge bundle.
- Switching platforms.
The exact labels may evolve with the plugin UI, but the command surface is centered on review, setup, diagnosis, and platform migration.
Activity Ledger
Activity receipts live in .knowlery/activity/YYYY-MM-DD.jsonl.
They are private summaries, not normal knowledge pages. The activity toggle in settings can disable logging by writing .knowlery/activity-disabled.
Weekly Summary and Daily Review
The weekly summary writes HTML output to:
.knowlery/reports/latest.html.knowlery/reports/weekly/<week-label>.html
Daily review polish uses:
.knowlery/requests/daily-review-YYYY-MM-DD.json.knowlery/reviews/daily-review-YYYY-MM-DD.json
Network Use
Knowlery does not collect telemetry.
Network access can happen when you explicitly use skill registry features through npx skills .... That command may contact services used by the external skills tooling.
Jev cook triage (optional, off until you add a TypeSafe AI API key) calls api.typesafe.ai when never-compiled notes are scored: the Rank button, knowlery triage, the capped top-up inside knowlery stale / MCP stale, or the background toggle if you switch it on. Each request carries a note's path, title, frontmatter and first 15 non-empty lines, plus the titles and descriptions of up to five shortlisted compiled pages — never full note bodies. The key lives only in the plugin's data.json under the vault config folder (or in TYPESAFE_API_KEY in your shell) and is never written into the vault, .knowlery/triage.json, or the registry. Retrieval never calls Jev.
Bundle install, publish, update and check-updates contact the URLs and GitHub repositories you point them at; private access goes through your own gh login.
Local Command Use
Knowlery can run local commands when you explicitly use CLI-related features or optional setup preparation.
Examples include:
claudeopencodenodenpxskills
These commands run on your computer with your user permissions.
Upgrade Behavior
When the plugin version changes, Knowlery refreshes bundled skills in .agents/skills/ and .claude/skills/, migrates SCHEMA.md by inserting any missing anchor sections, and refreshes the installed-bundles pointer block in KNOWLEDGE.md when bundles are installed. Since 1.6.0 the generated .knowlery/bin/query.mjs is also re-synced by content on every plugin load, so a same-version reload (for example a beta build swapped in place) never leaves a stale script behind; skills still refresh only on a version change or knowlery sync.
In v0.5.0, knowledge bundle sharing and installing arrived: the Bundles section on the dashboard, the Library/ folder, and .knowlery/bundles.json are new surfaces. In v0.4.0, dashboard maintenance moved into Obsidian settings: diagnostics, rules and schema shortcuts, and the Skills library are no longer separate dashboard tabs.
Custom and forked skills are preserved. Disabled built-in skills keep their disabled state, even though the on-disk bundled copy is refreshed.
Deletion Behavior
Knowlery may remove skill or rule files when you use delete or disable actions in the UI.
It should not delete ordinary user notes during setup. Still, test first and use version control or backups for important vaults.