README file from
GithubObsidian Replicate.com integration
Obsidian plugin that integrates Replicate.com and enables using the various image generation models supported by Replicate (e.g., Stable Diffusion, FLUX.1, and many more) directly from your vault.
Demo:
Features
- Generate images from the current selection or from a prompt entered in a modal.
- Configurable Replicate model (
<owner>/<name>or<owner>/<name>:<version>). - Free-form JSON input passed as
inputto the chosen model — works with any model that accepts aprompt. - Optional: copy the generated output (URLs) to the clipboard.
- Optional: append the generated output as markdown image embeds to the current note.
⚠️ Images generated via Replicate are only stored on Replicate's servers for one hour. Download anything you want to keep.
Prerequisites
- A Replicate.com account.
- A Replicate API token. Create one at replicate.com/account/api-tokens.
- A configured billing method on Replicate if the model you want to use is paid.
Installation
Community plugins (recommended)
- In Obsidian, go to Settings → Community plugins.
- Disable Restricted mode if it's enabled.
- Select Browse, search for Replicate, install it, then enable it.
You can also browse the catalog on the Obsidian Community website.
Manual installation
If the plugin isn't listed in the community catalog yet (or you want a specific version):
- Download
main.js,manifest.json, andstyles.cssfrom the latest release. - Copy them into
<Vault>/.obsidian/plugins/replicate/. - Reload Obsidian and enable Replicate in Settings → Community plugins.
BRAT (bleeding edge)
BRAT (Beta Reviewers Auto-update Tool) installs plugins straight from a GitHub repo and keeps them updated automatically. Use this if you want the latest commits — things might break.
- Install Obsidian42 - BRAT from Settings → Community plugins → Browse and enable it.
- Run BRAT: Add a beta plugin for testing from the command palette.
- Paste
https://github.com/dsebastien/obsidian-replicate. - Select the latest version and confirm.
- Enable Replicate in Settings → Community plugins.
Usage
Once the plugin is installed, enabled, and configured with your API key:
- Command palette: press
Ctrl/Cmd + P, search for Generate image(s) using Replicate.com, and pressEnter. - Context menu: right-click inside a note and pick the same command.
Behaviour:
- If you have text selected, that selection is used as the prompt.
- If nothing is selected, a modal is shown so you can type a prompt.
Ctrl/Cmd + Enterin the modal submits the prompt.
Configuration
See docs/configuration.md for the full reference.
Quick overview:
- Replicate.com API Key — your API token. Required.
- Copy output to clipboard — copies the generated URL(s) to the clipboard.
- Append output to current note — appends markdown image embeds to the active note.
- Image generation model —
<owner>/<name>or<owner>/<name>:<version>. - Image generation model configuration — JSON passed as the model's
input. The prompt is merged in at call time.
Privacy & data
- Network: the plugin only contacts Replicate.com. Requests are sent solely when you trigger a generation (command, context menu, or modal submit). Your prompt and model configuration are sent to Replicate to generate images. There is no telemetry, no background polling, and no auto-update.
- API key: your Replicate API token is stored locally in the plugin's settings (your vault) and sent only to Replicate for authentication. It is never logged.
- Clipboard: when Copy output to clipboard is enabled, the plugin writes the generated image URL(s) to your system clipboard. It never reads the clipboard. Disable the setting if you do not want clipboard writes.
- What's new after updates. After a plugin update, a one-time dialog shows the release notes you just received (including skipped versions) with ways to support development. Never shown on fresh installs or regular restarts.
Tips and tricks
See docs/tips.md for common tips, troubleshooting, and pointers for picking model versions.
Contributing
Contributions are welcome. See CONTRIBUTING.md.
License
MIT.
My other Obsidian plugins
| Plugin | What it does |
|---|---|
| Agentic Resource Discovery Server | Local-first Agentic Resource Discovery publisher and registry that serves your AI skills and tools to agents over a local HTTP and MCP server |
| Book Exporter | Export books (one manifest note + linked chapter notes) to EPUB and PDF via Pandoc |
| Bookshelf Base | Display your notes as a visual bookshelf via a custom Bases view |
| Dataview Serializer | Serialize Dataview queries to Markdown, and keep the Markdown representation up to date |
| Expander | Replace variables across your vault using HTML comment markers. Supports static values and dynamic functions |
| Ghost Publish | Publish your vault notes to a Ghost blog with configurable presets for tags, newsletters, and frontmatter conventions |
| Graph Explorer Base View | A custom Bases view that renders notes as an interactive force-directed graph with explored/unexplored tracking |
| Hidden Folders Access | Index hidden root-level folders (e.g. .claude) so they appear in the file tree, metadata cache, and Bases |
| Journal Bases | Custom Base views for journaling and periodic reviews |
| Kanban Action Planner | Render your notes as configurable Kanban boards and calendars inside Bases, with statuses, ordering, relationships, and scheduling |
| Life Tracker | Capture and visualize the data that matters in your life |
| Note Village | A 2D pixel art village where your notes become villagers you can explore and chat with using AI |
| Obsidian Starter Kit | Adds strong typing support and powerful automation support for notes |
| Remarkable Synchronizer | Connect to the reMarkable cloud, list, download, and sync notebook pages as images |
| REST and MCP server | Exposes CLI commands as RESTful API endpoints and an MCP server for AI tool integration |
| Time Machine | Browse, compare, and restore previous versions of your notes using built-in file-recovery snapshots |
| Transcriber | Transcribe images to markdown using Ollama vision models |
| Typefully | Publish social media posts with ease using the Typefully integration |
| Update Time | Automatically update front matter to include creation and last update times |
Everything I build is documented in my newsletter and on my YouTube channel.
News & support
To stay up to date about this plugin, Obsidian in general, Personal Knowledge Management and note-taking:
- Subscribe to my newsletter
- Subscribe to my YouTube channel
- Join the Knowii community and learn to organize your notes and put your knowledge to work, together with fellow knowledge workers
If this plugin is useful to you, here are the best ways to support my work ❤️:
- Join the Knowii community
- Become a GitHub Sponsor
- Buy me a coffee
- Subscribe to my YouTube channel
- Check out my products
Found a bug or have an idea? Open an issue.