obsidian-knowledge-vault

Create a safe, automated starting point for a new Obsidian vault with selectable templates, schedules, and AI providers.

Obsidian Knowledge Vault

English | 中文

Release CI CodeQL License Last commit

Create a safe, automated starting point for a new Obsidian vault. Choose a General or Legal template, choose when organization runs, connect an AI provider you trust, and send material to one inbox for structured processing.

What it is

Obsidian Knowledge Vault is an installer and maintenance toolkit for a fresh, empty Obsidian vault. Its two templates share the same organizing system; only the work-directory taxonomy differs:

  • General — for ordinary work, life, learning, records, and system rules.
  • Legal — for legal-profession work, with a legal work taxonomy.

The local maintenance program accepts constrained AI organization plans, checks them locally, and writes only permitted files. It does not publish your notes or use a cloud service run by this project.

Install

Create a new, empty folder for the vault. Version 1.2 deliberately refuses to install into an existing vault, so it cannot alter existing notes or Obsidian settings.

git clone https://github.com/songoao25/obsidian-knowledge-vault.git
cd obsidian-knowledge-vault
python3 deploy.py

The installer asks you to choose a template, schedule, AI provider, and one final local approval. You can also download the macOS or Windows package from the latest Release.

Platforms and AI choices

PlatformAI choices
macOSChatGPT Desktop, DeepSeek, or a user-supplied OpenAI-compatible provider
WindowsDeepSeek or a user-supplied OpenAI-compatible provider

API keys are requested only through hidden local input and stay in the user's local credential store. Never paste a key into an Issue or AI chat.

Daily use

Put material that needs organization into the chosen inbox, then let the schedule you selected run. You can change schedules, AI providers, and local rules later without replacing your vault.

For the full workflow, see Daily use.

Documentation

English中文
Installation安装
Daily use日常使用
Customization自定义
Troubleshooting排错

Privacy and safety

  • This repository and its release packages contain templates and code only—no personal notes, credentials, logs, recovery data, or computer-specific paths.
  • Content is sent only to the provider you actively choose during setup.
  • Existing-vault migration is deliberately outside v1.2. Do not use this installer on an existing vault.
  • For ordinary problems, use Issues, and never include credentials or real notes.

Release files

The v1.2.0 Release contains macOS and Windows packages plus a SHA-256 checksum file.

License

MIT © 2026 songoao25

Related

How to Install

  1. Download the ZIP or clone the repository
  2. Open the folder as a vault in Obsidian (File → Open Vault)
  3. Obsidian will prompt you to install required plugins

Stats

Stars

0

Forks

0

License

MIT

Last updated 5d ago

Categories

Tags

aiautomationknowledge-managementmacosobsidianpythonwindows