Guides
These guides cover the everyday workflows that Knowlery supports.
Initialize a Vault
- Open the command palette.
- Run Knowlery: Initialize vault.
- Choose Claude Code or OpenCode.
- Review the files, skills, and configuration Knowlery will create.
- Optionally select missing tool preparation steps.
- Run setup.
- Open the dashboard when setup completes.
Use a test vault first if you are evaluating Knowlery. Setup writes several top-level files and folders.
Read the Dashboard
Knowlery now centers on one action-first dashboard:
| Section | What to do there |
|---|---|
| Today's move | Start with the current activity state and pick one small next move |
| Suggested moves | Copy or send reusable prompts such as Process new material, Connect related notes, Challenge an idea, Fix note metadata, or Draft an output |
| Knowledge health | Open Freshness Review when suggestions are waiting |
| This note | Review the active Markdown note and ask for related connections |
| Recent activity | Inspect recent private activity receipts |
| This week | Generate a weekly summary or send a polish request |
| Bundles | Share a reviewed knowledge bundle or install one from someone else |
Use the refresh button when recent activity or vault changes need to be reflected. Use View all links for longer move and activity lists.
Work with Today's Move
Today's move is the quickest way to understand what Knowlery thinks is happening in your vault.
- Open the dashboard.
- Read the current summary and the highlighted next move.
- Use the copy or send action if you want an agent prompt.
- Use Add reflection if you want to record a private note about your own work.
If you already have activity receipts, Knowlery will show active knowledge threads and likely next moves. If you do not, it will steer you toward the first cook or a small setup step.
Review a Note
Open a Markdown note and look at the This note section on the dashboard.
Knowlery will try to identify the active note, relate it to recent knowledge activity, and prepare a focused prompt. Use this when you want to ask an agent to connect one note to older material, comparisons, or reusable structures.
Generate a Weekly Summary
Use This week when you want a broader summary.
- Use Generate summary to create a local HTML report in
.knowlery/reports/latest.html. - Use Open last report to open that file outside Obsidian.
- Use Send for review when you want a companion agent to write a more polished review summary.
- Use Check result to refresh the request/result state.
The report also saves a dated snapshot under .knowlery/reports/weekly/.
Use Suggested Moves
Suggested moves are the place to start from product-language actions instead of raw skill names.
The move catalog includes:
| Move | What it is for |
|---|---|
| Process new material | Turn rough notes, clips, or conversations into durable knowledge pages |
| Connect related notes | Find older notes, adjacent themes, and reusable patterns |
| Challenge an idea | Check assumptions, missing evidence, counterexamples, and risks |
| Fix note metadata | Review drift, duplicates, frontmatter gaps, broken links, and index hygiene |
| Draft an output | Turn a mature topic into a checklist, outline, template, proposal, or decision memo |
Open a move to copy its prompt or send it to your configured agent chat. Open Settings -> Knowlery -> Skills to inspect, create, fork, edit, disable, or delete the underlying skills.
Recommended Skill Flow
| Goal | Skill |
|---|---|
| Process raw notes | cook |
| Ask what the vault already knows | ask |
| Find bridges between topics | explore |
| Review assumptions | challenge |
| Generate synthesis ideas | ideas |
| Check for structural problems | audit |
| Clean up organization | organize |
Share a Knowledge Bundle
Use Share knowledge bundle (command palette or the Bundles section on the dashboard) when you want to give someone else a reviewed slice of your knowledge.
- Pick a seed topic. Knowlery collects the graph-closure of connected knowledge pages and cited raw sources.
- Review every item in scope. Each page and source is unreviewed, approved, or flagged — nothing ships until you approve it.
- Check the automated risk scan. It highlights emails, sensitive URLs, person pages, and meeting-like notes before export.
- Confirm the bundle metadata (id, title, version, creator, license) and options.
- Export. The bundle is written under
.knowlery/exports/and can be saved as a.zipfor sharing.
The exported bundle contains the approved pages, an index.md and agent-index.json for navigation, approved raw sources under _sources/, an update log, and a README for the recipient. If "Include SCHEMA.md" is on, the shipped schema is scoped to the tags and domains the exported pages actually use — never your vault-wide taxonomy.
Each topic keeps its own saved review scope, so working on one bundle never disturbs another.
Install a Knowledge Bundle
Use Install knowledge bundle (command palette or the dashboard card) to add a bundle someone shared with you.
- Choose the bundle
.zipor folder. - Review the manifest and conformance preview before anything is written.
- Install. The bundle lands in
Library/<bundle-id>/and is registered in.knowlery/bundles.json.
Installed bundles are listed on the dashboard, where they can also be uninstalled. Installing adds a retrieval pointer to KNOWLEDGE.md, and the /ask skill checks installed bundles explicitly when answering questions. Updates require a newer bundle version; installing past a conformance failure requires explicit acknowledgement.
When you want to make an installed bundle page your own, use Fork to my knowledge from the file menu on a bundle concept page — it copies the page into your own knowledge directories.
Add or Edit Rules
Rules guide agent behavior in this vault.
- Open Settings -> Knowlery.
- Use Add rule to create a new rule.
- Give the rule a focused filename and title.
- Write plain markdown instructions.
- Save and verify the rule appears in the rules list.
Good rules are short and enforceable. Prefer “Always cite source notes using wikilinks” over a broad essay about writing style.
Switch Platforms
Use the settings tab to switch between Claude Code and OpenCode.
Knowlery will:
- Create the target rules directory if needed.
- Copy markdown rule files from the old platform directory to the new one.
- Regenerate the platform configuration file.
- Optionally clean up the previous platform config.
Review generated config after switching platforms, especially if you have custom rules.
Run a Health Diagnosis
Open Settings -> Knowlery, then use the Diagnostics section and click Run diagnosis.
Knowlery checks:
- Orphan notes with no incoming wikilinks.
- Broken wikilinks that do not resolve to existing files.
- Missing frontmatter in
entities/,concepts/,comparisons/, andqueries/.
Health output is advisory. Review findings before restructuring a real vault.
Run Freshness Review
Use Freshness Review when you want an agent to check whether compiled knowledge pages are outdated or superseded.
- Open Knowledge health from the dashboard.
- Use Prepare request to write a request JSON file under
.knowlery/freshness/requests/. - Copy the prompt and run the agent separately.
- Put the result JSON where the request asks, then use Import results.
- Review each suggestion before applying, dismissing, or marking it incorrect.
Knowlery only patches scalar freshness frontmatter after approval. It does not call a model API for this workflow.
Capture Reflection
Use Add reflection from the command palette or dashboard when you want to capture a private summary of what happened in an agent session or a manual review.
The reflection lives in the Activity Ledger, not in a normal vault note.
Regenerate Agent Config
If your agent instructions drift or a config file is accidentally edited, use the settings tab to regenerate platform config.
This is useful after changing the knowledge base name, switching platforms, or repairing a partially initialized vault.
Work Safely With Agents
Use these conventions when asking an agent to work in a Knowlery vault:
- Ask the agent to read
KNOWLEDGE.mdfirst. - Keep source notes separate from compiled knowledge pages.
- Ask for citations with
[[wikilinks]]. - Review generated knowledge pages before relying on them.
- Run Health after large imports, migrations, or agent-generated changes.