https://github.com/pticalin/vaultos
VaultOS is a modular orchestration engine for Obsidian. It manages, compiles, and controls subplugins inside your vault.
https://github.com/pticalin/vaultos
cli-tool digital-garden digital-gardening markdown note-taking obsidian-plugin personal-knowledge-base productivity structured-notes typescript vault-management vaultos
Last synced: 3 months ago
JSON representation
VaultOS is a modular orchestration engine for Obsidian. It manages, compiles, and controls subplugins inside your vault.
- Host: GitHub
- URL: https://github.com/pticalin/vaultos
- Owner: PtiCalin
- License: other
- Created: 2025-05-30T16:25:59.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-06-08T17:22:41.000Z (4 months ago)
- Last Synced: 2025-06-08T17:34:59.189Z (4 months ago)
- Topics: cli-tool, digital-garden, digital-gardening, markdown, note-taking, obsidian-plugin, personal-knowledge-base, productivity, structured-notes, typescript, vault-management, vaultos
- Language: TypeScript
- Homepage:
- Size: 108 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# 🧠 VaultOS – Plugin for Obsidian
> VaultOS is a modular plugin orchestration system for [Obsidian](https://obsidian.md) – designed to manage, compile, and control an ecosystem of VaultOS-powered subplugins right from your vault.
[](./LICENSE)
[](https://obsidian.md)
[](./manifest.json)
[](https://github.com/PtiCalin)
---
### ✨ What is VaultOS?
VaultOS is the beating heart of a modular dev environment inside Obsidian. It watches your plugin folder, auto-registers and compiles VaultOS submodules, and provides an elegant control panel for managing your extended vault OS.
Whether you're building a single subplugin or orchestrating dozens, VaultOS gives you a solid foundation.
---
### 🔧 Core Features
- 🧩 **Auto-detect `vaultos_*` folders** and treat them as managed subplugins
- ⚙️ **Subplugin scaffolder** to generate all required files and folders
- 📦 **Converter, Relocator, Validator, and Compilator** utilities to streamline module deployment
- 💾 **Module metadata cache** for tracking status, structure, and logs
- 🪟 **VaultOS UI Panel** inside Obsidian's workspace (left or right dock)
- 📁 **Manifest builder** for compiling subplugin metadata into the main manifest
- 📑 **Logging system** to track plugin events and actions
---
### 📁 Folder Structure
```
├── main.ts # The plugin entry point
├── src/
│ ├── core/ # Watcher, logger, cache, UI panel view
│ ├── modules/ # Module manager and subplugin scaffolder
│ ├── ops/ # Converter, validator, relocator, compiler
│ └── templates/ # Handlebars scaffolding templates
├── dist/ # Finalized plugin builds and JSON configs
├── data/ # Cache, logs, backups
└── config/ # vaultos_config_extended.json and variants
```
---
### 📦 Getting Started
```bash
# 1. Clone this repository anywhere on your machine
git clone https://github.com/PtiCalin/vaultos.git
cd vaultos
# 2. Install dependencies and run tests
./setup.sh
# Run `ENABLE_NET=1 ./setup.sh` if you need to fetch packages from the internet
# 3. Build the plugin
npm run build
# 4. Copy `manifest.json` and `main.js` to your vault's
# `.obsidian/plugins/vaultos/` folder
```
After copying the built files you can reload Obsidian to use VaultOS.
To distribute the plugin, package the same files in a GitHub release
following the [community plugin guidelines](https://docs.obsidian.md/Plugins/Community+plugins/Publishing+plugins).
---
### 🚀 Powered By
- [Obsidian API](https://docs.obsidian.md/)
- [TypeScript](https://www.typescriptlang.org/)
- [Handlebars](https://handlebarsjs.com/) for template scaffolding
- ❤️ Curiosity and caffeine
---
### 🤝 Contributing
Contributions welcome! Check out [`CONTRIBUTING.md`](./CONTRIBUTING.md) to learn more.
---
### 🧪 Status
This is an alpha kernel release of VaultOS. Expect improvements to:
- Configuration parsing
- UI panel features
- Plugin lifecycle automation
> Built by [@PtiCalin](https://github.com/PtiCalin) · Join the [Discord](https://discord.gg/dX8ZPDrN)
---
🌌 A modular engine for a modular mind.