✨ Inline AI an Obsidian Plugin

Type /ai + your prompt → Press Enter → AI response streams directly into your note

Never leave your note to get AI help. Generate text, brainstorm, summarize, and refactor—all inline.

🚀 Quick Start (30 seconds)

git clone https://github.com/nitinvishway/Inline-AI.git
cd Inline-AI
npm install && npm run build
# Copy main.js + manifest.json + styles.css to .obsidian/plugins/Inline-AI/

📝 How to Use

Basic Syntax

/ai your prompt here

Press Enter ↵ → AI responds inline → Line is replaced with the response.

Examples

📚 Writing

/ai expand this idea into 3 paragraphs: [your text]

↓ Becomes: ↓

[AI-generated 3-paragraph expansion]

🧠 Brainstorming

/ai generate 5 blog post titles about productivity

📋 Summarizing

/ai summarize this in 2 sentences: [paste meeting notes]

🔄 Refactoring

/ai make this less wordy: The quick brown fox jumps over the lazy dog

🎨 Creative

/ai write a haiku about procrastination

📦 Submission Checklist

Before publishing to the Obsidian Community site, make sure:

1. manifest.json has a unique id and does not contain "obsidian".
2. The repo root includes README.md, LICENSE, manifest.json, main.js, and styles.css.
3. Any file paths handled in code are passed through Obsidian's normalizePath() for cross-platform safety.
4. The release tag matches the version in manifest.json.

🔧 Setup by Provider

🦙 Ollama (Local, Private, Free) — Recommended for Privacy

Why choose Ollama?

• ✅ Runs on your machine (no data sent to cloud)
• ✅ Completely free
• ✅ Works offline
• ✅ Lightning fast

Setup (5 minutes):

1. Install Ollama → Download from ollama.com
2. Start Ollama:

   ollama pull llama3.2  # or: mistral, phi3, neural-chat
   ollama serve
   

3. In Obsidian:
   • Settings → Inline AI
   • Provider: Ollama
   • URL: http://localhost:11434 (default)
   • Model: llama3.2

✅ Done! Try: /ai explain quantum computing

Models to try:

• llama3.2 — Balanced (fast + smart)
• mistral — Fastest
• phi3 — Best for long context
• neural-chat — Good reasoning

# In WSL, start with:
OLLAMA_HOST=0.0.0.0 ollama serve

# Find WSL IP:
ip addr show eth0 | grep "inet "
# Copy the IP, e.g., 172.28.144.5

🤖 OpenAI ChatGPT — Best Quality

Why choose OpenAI?

• ✅ Highest quality responses
• ✅ Fast and reliable
• ✅ Large context window
• ✅ Latest models available

Setup (2 minutes):

1. Get API Key:

   • Go to platform.openai.com/api/keys
   • Create new secret key
   • Copy it

2. In Obsidian:

   • Settings → Inline AI
   • Provider: OpenAI
   • Paste your API key
   • Model: gpt-4o-mini (cheap) or gpt-4 (premium)

✅ Done!

Cost estimate: ~$0.01 per prompt (very cheap)

🧠 Anthropic Claude — Best Reasoning

Why choose Claude?

• ✅ Excellent at long-form writing
• ✅ Better reasoning than GPT
• ✅ Good value for money
• ✅ Thoughtful responses

Setup (2 minutes):

1. Get API Key:

   • Go to console.anthropic.com/keys
   • Create new API key
   • Copy it

2. In Obsidian:

   • Settings → Inline AI
   • Provider: Claude
   • Paste your API key
   • Model: claude-3-5-sonnet-20241022

✅ Done!

✨ Google Gemini — Fastest + Free Tier

Why choose Gemini?

• ✅ Extremely fast
• ✅ Free tier available (no credit card needed initially)
• ✅ Good for quick queries
• ✅ Integrated with Google ecosystem

Setup (1 minute):

1. Get API Key:

   • Go to aistudio.google.com
   • Click "Get API Key"
   • Create new API key
   • Copy it

2. In Obsidian:

   • Settings → Inline AI
   • Provider: Gemini
   • Paste your API key
   • Model: gemini-2.0-flash

✅ Done!

⚙️ Advanced Settings

🌐 Web Search (Optional)

Get live information in your prompts:

/ai what are the latest AI breakthroughs in 2024?

→ Plugin searches → Injects results → AI responds with current info

To enable:

1. Settings → Inline AI → Toggle "Enable Web Search"
2. Choose search engine:
   • DuckDuckGo — Works instantly, no setup
   • Google Custom Search — More thorough, requires API key

🎯 Real-World Use Cases

📖 Writer

/ai make this paragraph more engaging: [paste]

🧑‍💻 Developer

/ai explain what this code does: [paste code]

📚 Student

/ai create 5 study questions about photosynthesis

🧠 Researcher

/ai summarize this abstract and extract key findings: [paste]

📊 Analyst

/ai what trends do you see in this data: [paste data]

🎨 Designer

/ai generate 3 color palettes for a fintech app

🐛 Troubleshooting

⌨️ Keyboard Shortcut

Don't have a command? Use the Ask AI command:

1. Obsidian Command Palette (Ctrl+K / Cmd+K)
2. Search "Ask AI"
3. Press Enter
4. Type your prompt

🔐 Privacy & Data

• Ollama: ✅ All processing local. No data leaves your machine.
• OpenAI/Claude/Gemini: Data sent to their servers per their privacy policies.

💡 Tips & Tricks

System Prompt Magic

Set a system prompt in Settings to customize AI behavior:

Example 1: You are a professional editor. Be concise but thorough.

Example 2: Output markdown formatted responses.

Example 3: Always explain your reasoning.

Temperature for Different Tasks

• 0.0 (Precise) → Summaries, facts, code
• 0.5 (Balanced) → General writing
• 1.0 (Creative) → Brainstorming, fiction

Combine with Web Search

/ai what happened in tech today?

(with web search enabled)

🤝 Contributing

Found a bug? Want a feature?

• Bug reports: Open an issue on GitHub
• Feature requests: Discuss in Discussions or issues
• Development: See Development section

📦 Development

Local Setup

git clone https://github.com/nitinvishway/Inline-AI.git
cd Inline-AI
npm install
npm run dev          # Watch mode (rebuild on save)

Testing

1. Copy main.js and manifest.json to .obsidian/plugins/Inline-AI/
2. Reload Obsidian (Ctrl+R / Cmd+R)
3. Test changes in real-time

Hot Reload (Optional)

Install the Hot-Reload plugin for instant updates without restarting Obsidian.

📄 License

MIT — Use freely, modify, distribute.

❓ FAQ

🙌 Support

• Docs & Guides: This README
• Issues: GitHub Issues
• Discussions: GitHub Discussions

Made with ❤️ for writers, thinkers, and builders.