README file from
GithubSystemSculpt AI (Obsidian Plugin)
AI chat, semantic search, meeting transcription, image generation, and agent workflows — inside your Obsidian vault, on your terms.
Bring your own API keys (no license wall) or use managed models with SystemSculpt Pro. Every AI file change can be reviewed before it touches your notes.
Why SystemSculpt AI
- Chat with your vault. Conversational AI that reads, searches, and reasons over your notes, with custom system prompts loaded from vault markdown files and favorite-filtered model selection.
- Agents you stay in control of. Toggle agent mode for tool-assisted workflows — read, search, edit, move, and organize notes — with review-before-change so AI never silently rewrites your vault.
- Semantic search that survives sync (Pro). Find notes by meaning with embeddings, backed by a portable index that survives Obsidian Sync and vault restore.
- Voice to notes. Record audio and transcribe meetings or voice memos straight into markdown, including self-hosted Whisper and a separate post-processing model.
- Image generation in Studio. Generate images from a Studio canvas node: pick the model, aspect ratio, image size, seed, and batch count.
- Automations. Capture-folder workflows that process new files automatically.
- Your keys, your models. Native Anthropic (Claude), Google (Gemini), OpenAI, xAI, and OpenRouter support, plus local Pi providers with clear Ollama guidance. BYOK chat never hits a SystemSculpt license wall.
Works on desktop and mobile.
Free vs Pro
- Bring your own keys: BYOK-powered chat and features run entirely on your own provider keys.
- SystemSculpt Pro: managed models with no key setup, semantic search / Similar Notes, hosted transcription and image credits, and priority support — $19/month or $149 lifetime. Details at systemsculpt.com/pricing.
Quick start
- Install SystemSculpt AI from Obsidian Community Plugins.
- Open
Settings -> SystemSculpt AI. - Add a provider key under
Providers, or activate a Pro license underAccount. - Run the command
Open SystemSculpt Chat. - Optional (Pro license required): enable embeddings in
Knowledgefor Similar Notes.
Privacy and safety
- BYOK requests go to your chosen provider with your keys.
- Agent edits support review-before-change, and agent tool policies (including command approval) are enforced and synced.
- License keys are redacted from logs.
Docs
- Docs hub: docs/README.md
- Getting started: docs/user/getting-started.md
- Settings reference: docs/user/settings.md
- Commands: docs/user/commands.md
- Ribbon icons: docs/user/ribbon-icons.md
- Similar Notes: docs/user/similar-notes.md
- Audio & transcription: docs/user/audio-transcription.md
- Automations: docs/user/automations.md
- Troubleshooting: docs/user/troubleshooting.md
Installation
Community Plugins (recommended)
- Open Obsidian
Settings -> Community plugins. - Search for
SystemSculpt AI. - Click
Install, thenEnable.
Manual install
cd /path/to/vault/.obsidian/plugins/
git clone https://github.com/systemsculpt/obsidian-systemsculpt-ai systemsculpt-ai
cd systemsculpt-ai
npm install
npm run build
Current release facts
- Plugin version:
5.10.0 - Minimum Obsidian version:
1.4.0 - Platforms: desktop and mobile (
manifest.jsonsetsisDesktopOnly: false) - License: MIT
Development
Build, test, sync, and release documentation lives in docs/development.md, with contributor gates in CONTRIBUTING.md. Common entry points:
npm run dev # watch build
npm run build # production build
npm run check:plugin # typecheck + bundle resolution
npm run check:all # plugin check + Jest suite
npm test # full unit suite
Support
- Website:
https://systemsculpt.com - Repo:
https://github.com/SystemSculpt/obsidian-systemsculpt-ai - Issues:
https://github.com/SystemSculpt/obsidian-systemsculpt-ai/issues - Email:
[email protected]
License
MIT. See LICENSE.