Setup
Complete setup guide for SystemSculpt AI with all supported providers
Install SystemSculpt
From Obsidian (recommended)
- Open Obsidian Settings (click the gear icon ⚙️)
- Click "Community Plugins" on the left
- Click "Browse" and search for "SystemSculpt"
- Click "Install" then "Enable"
- You'll see a message square icon in your left sidebar
✅ That's it! Now set up your AI provider.
Manual installation
⚠️ Only if the above doesn't work:
-
Download the plugin
- Go to: https://github.com/systemsculpt/obsidian-systemsculpt-ai/releases
- Download the latest .zip file
-
Find your plugins folder
- In your vault folder, find the hidden
.obsidian
folder - Inside that, find
plugins
folder - Create a new folder called
systemsculpt-ai
- In your vault folder, find the hidden
-
Install the files
- Extract the zip file into the
systemsculpt-ai
folder - Restart Obsidian
- Extract the zip file into the
-
Enable the plugin
- Go to Settings → Community Plugins
- Find SystemSculpt and toggle it on
Choose your AI provider
Quick setup
Provider | Setup time | What you need |
---|---|---|
SystemSculpt AI | Instant | Nothing - works right away |
OpenAI | 2 minutes | An account at OpenAI (like ChatGPT) |
Anthropic | 2 minutes | An account at Anthropic (Claude) |
Ollama | 5 minutes | Free software for your computer |
OpenRouter | 2 minutes | An account at OpenRouter |
Provider setup
SystemSculpt AI (easiest)
💡 Quick setup with premium models!
- Get your license key at systemsculpt.com
- Go to Settings → SystemSculpt → Setup
- Add your license key and save
- Click the model indicator button in any chat
- Select a SystemSculpt model and start chatting
Note: SystemSculpt AI requires a valid license key (monthly or lifetime)
OpenAI
-
Get your secret key
- Go to https://platform.openai.com/api-keys
- Sign in with your OpenAI account
- Click "Create new secret key"
- Copy the key that starts with "sk-"
-
Add it to SystemSculpt
- Open Settings in Obsidian
- Find SystemSculpt → Providers → OpenAI
- Paste your key and click Save
-
Choose a model
- In any chat, click the model name at the top
- Pick an OpenAI model from the list
💰 Pricing: Usage-based pricing
Anthropic
-
Get your secret key
- Go to https://console.anthropic.com
- Sign in or create an account
- Find "API Keys" and create a new one
- Copy the key that starts with "sk-ant-"
-
Add it to SystemSculpt
- Open Settings in Obsidian
- Find SystemSculpt → Providers → Anthropic
- Paste your key and click Save
-
Choose a model
- In any chat, click the model name at the top
- Pick a Claude model from the list
💰 Pricing: Pay per use
Local AI with Ollama (private & free)
-
Install Ollama on your computer
- Go to https://ollama.com/download
- Download and install like any other app
- It runs AI models on your computer (no internet needed)
-
Get an AI model
- Open Terminal (Mac) or Command Prompt (Windows)
- Type:
ollama pull [model-name]
(replace with your chosen model) - Wait for it to download (like downloading an app)
-
Connect to SystemSculpt
- Open Settings in Obsidian
- Find SystemSculpt → Providers → Ollama
- Toggle it on
-
Start using it
- In any chat, select a local model
- Everything stays on your computer!
📚 Getting started with local models:
- Choose a general-purpose model for everyday chat
- Try a specialized model for specific tasks like writing or coding
- Start with smaller models if you have limited resources
OpenRouter
-
Get your key
- Go to https://openrouter.ai/keys
- Sign up for a free account
- Create a new key and copy it
-
Add it to SystemSculpt
- Open Settings in Obsidian
- Find SystemSculpt → Providers → OpenRouter
- Paste your key and click Save
-
Pick from many models
- In any chat, you'll see many AI models to choose from
- Try different ones to see what you like!
Verify installation
Quick test
- Click message square icon in sidebar
- Type "Hello!" and press Enter
- See AI response
🎉 Success! You're ready to use AI in Obsidian!
Troubleshooting
⚠️ Common issues and quick fixes:
Issue | Fix |
---|---|
No message square icon | Ensure plugin is enabled in Settings → Community Plugins |
"No models available" | You need to add a provider first (see instructions above) |
Chat won't open | Restart Obsidian (close and reopen) |
Key not working | Make sure you copied the whole key with no spaces |
Mobile setup
iOS/Android
- Install Obsidian mobile app
- Open your vault
- Settings → Community Plugins → SystemSculpt
- Same provider setup as desktop
- Chat icon appears in sidebar
📝 Note: Some features limited on mobile (no local AI)
First-time configuration
Essential settings
Where chats are saved:
- Settings → SystemSculpt → Directories
- Look for "Chats Directory"
- Default is
SystemSculpt/Chats/
(this is fine for most people)
Safety settings:
- Settings → SystemSculpt → Features
- Agent Mode requires Pro license
- When enabled, AI will ask permission before making changes
Settings for different users
🔬 If you're a researcher:
- Turn on "Embeddings" for smart search (Pro feature)
- This helps find related notes by meaning
✍️ If you're a writer:
- Choose system prompt type in "AI Chat" settings
- Select "General Use" or "Concise" presets
🛠️ If you want full control:
- Check console logs for technical details
- Create custom system prompts in markdown files
Next steps
New to AI?
Quick Start Guide - Your first chat in 3 steps
Ready to explore?
- Chat Features - Everything you can do
- Agent Mode - Let AI manage your vault (Pro)
- Commands - Commands and workflows
Need help?
- Discord - Get instant help from the community
- Email Support - Direct support from Mike
Advanced installation
Beta versions (for testers)
If you want to try new features before they're released:
- Install the "BRAT" plugin from Community Plugins
- In BRAT settings, click "Add Beta Plugin"
- Paste:
systemsculpt/obsidian-systemsculpt-ai
- Choose "beta" when asked
⚠️ Warning: Beta versions might have bugs!
Build from source
Bashgit clone https://github.com/systemsculpt/obsidian-systemsculpt-ai cd obsidian-systemsculpt-ai npm install npm run build # Copy to .obsidian/plugins/systemsculpt-ai/
Environment variables
For advanced users:
Bash# Custom API endpoints SYSTEMSCULPT_API_URL=https://your-endpoint.com # Proxy configuration HTTPS_PROXY=http://proxy.company.com:8080
Uninstalling SystemSculpt
Bash1. Settings → Community Plugins 2. Find SystemSculpt AI → Disable 3. Optional: Delete plugin folder 4. Your chats remain in vault (delete manually if needed)
Need help? Join our Discord or email mike@systemsculpt.com