obsidian-plugin/fbarrca_obsidian-inlineAI
1
0
Fork 0
mirror of https://github.com/fbarrca/obsidian-inlineAI.git synced 2026-07-22 11:50:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
128 commits 4 branches 23 tags 1.8 MiB
TypeScript 94.4%
CSS 3.8%
JavaScript 1.8%
Find a file
Felix Isaac Lim b389c5991d fix: use Obsidian requestUrl instead of fetch (CSP bypass), add model dropdown 
native fetch blocked by Obsidian CSP for external domains; requestUrl
bypasses it. Also adds Codex model dropdown with known models + custom
fallback, updates normalizeModel for gpt-5.5/5.4-mini/5.3-codex-spark.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-23 06:18:39 +08:00
.github Reformat the code with the new prettier config 2025-09-12 18:47:27 +02:00
.husky Refactor project configuration: remove .gptignore, add .prettierignore and .prettierrc, update package-lock.json with new dependencies including husky and lint-staged, and configure GitHub Actions for Prettier checks. Also, set up husky pre-commit hook to run tests. 2025-09-12 18:46:02 +02:00
docs Update README and change hotkey for AI tool activation 2025-01-06 01:18:50 +01:00
src fix: use Obsidian requestUrl instead of fetch (CSP bypass), add model dropdown 2026-05-23 06:18:39 +08:00
.editorconfig Init plugin template 2024-10-25 20:58:08 +02:00
.eslintignore Init plugin template 2024-10-25 20:58:08 +02:00
.eslintrc Init plugin template 2024-10-25 20:58:08 +02:00
.gitignore Add settings management and integrate LangChain API for chat functionality with multiple providers 2024-11-01 17:39:57 +01:00
.npmrc Init plugin template 2024-10-25 20:58:08 +02:00
.prettierignore Refactor project configuration: remove .gptignore, add .prettierignore and .prettierrc, update package-lock.json with new dependencies including husky and lint-staged, and configure GitHub Actions for Prettier checks. Also, set up husky pre-commit hook to run tests. 2025-09-12 18:46:02 +02:00
.prettierrc Reformat the code with the new prettier config 2025-09-12 18:47:27 +02:00
esbuild.config.mjs Refactor TypeScript configuration and update package dependencies, we wont use svelte as its giving trouble 2024-10-27 19:33:05 +01:00
LICENSE Create LICENSE 2025-01-06 22:36:17 +01:00
manifest.json [release] Bump version to 1.2.4 2025-09-19 17:28:48 +02:00
package-lock.json [release] Bump version to 1.2.4 2025-09-19 17:28:48 +02:00
package.json [release] Bump version to 1.2.4 2025-09-19 17:28:48 +02:00
README.md Reformat the code with the new prettier config 2025-09-12 18:47:27 +02:00
styles.css Reformat the code with the new prettier config 2025-09-12 18:47:27 +02:00
tsconfig.json Switch diff dependency for semantic cleanup 2025-01-05 16:27:24 +01:00
version-bump.mjs Init plugin template 2024-10-25 20:58:08 +02:00
versions.json Init plugin template 2024-10-25 20:58:08 +02:00

README.md

InlineAI Plugin

Documentation · Report Bug · Discussions

demo

💡 A Seamless AI Writing Experience in Obsidian

InlineAI enhances your workflow by integrating AI-powered suggestions, contextual edits, and advanced text transformations directly into your editor. Write faster, edit smarter, and unlock new creative possibilities—all within the Obsidian editor.

🌟 Features

1. Context-Aware AI Assistance

  • Transform text, summarize, or rewrite content using prompts tailored to your needs.
  • Define your own system and transformation prompts as commands for highly customized workflows.

2. Inline Diff Visualization

  • Visualize AI-suggested changes with clear inline markers for added and removed text.
  • Accept or discard suggestions with a single click.

3. Full AI Integration

  • Supports OpenAI, Ollama,Gemini and other APIs.
  • Local model support for privacy-first workflows.

⚙️ Installation

1. From Obsidian Plugin Store

  1. Open Obsidian Settings.
  2. Navigate to Community Plugins → Browse.
  3. Search for "InlineAI" and click Install.
  4. Enable the plugin in the Installed Plugins list.

2. Manual Installation

  1. Download the latest release from the GitHub Releases.
  2. Copy main.js, styles.css, and manifest.json into your vault's .obsidian/plugins/obsidian-inlineai/ directory.
  3. Enable the plugin via the Community Plugins tab.

🚀 Getting Started

Initial Setup

  1. Set up your API key:

    • Open the plugin settings in Obsidian.
    • Enter your API key for OpenAI, Ollama, Gemini or any supported model provider.

  2. Choose a model:

    • Supported models include gpt-4, llama3.2, and others.

  3. Configure prompts:

    • Define system and transformation prompts in settings for customized interactions.

How to Use

  • Trigger AI Tooltips: Highlight text or place the cursor, then press Ctrl + K / Cmd + K to activate the tooltip(you can change the hotkey).
  • Apply Edits: Use the inline diff view to accept or discard AI-suggested changes.

🙏 Feedback and Support

We value your feedback and aim to make InlineAI the ultimate AI writing assistant:

🛠️ Development

Want to contribute? Here’s how:

  1. Clone the repository:

    
git clone https://github.com/FBarrca/obsidian-inlineai.git

  2. Install dependencies:

    
npm install

  3. Build the plugin:

    
npm run build

📝 License

This project is licensed under the GPL-3.0 license. Feel free to fork, contribute, and enhance the plugin!