obsidian-plugin/shadielfares_ingester
1
0
Fork 0
mirror of https://github.com/shadielfares/ingester.git synced 2026-07-22 17:20:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
117 commits 1 branch 6 tags 283 KiB
TypeScript 74.3%
JavaScript 25.7%
Find a file
shadielfares 0b50817503 docs: note about matching watch folder in skill
2026-04-23 02:06:23 -04:00
.github/workflows remove: styles.css in build 2026-04-22 19:17:40 -04:00
skills/ingest refactor: rename to Ingester, add /ingest skill 2026-04-23 02:03:18 -04:00
src refactor: rename to Ingester, add /ingest skill 2026-04-23 02:03:18 -04:00
.editorconfig use LF instead of CRLF (#28) 2022-04-15 14:13:31 -04:00
.gitignore Update .gitignore (#25) 2022-01-28 10:34:53 -05:00
.npmrc add version bump script (#10) 2022-01-22 16:13:50 -05:00
CLAUDE.md rename: Agents.md -> Claude.md 2026-04-22 16:29:43 -04:00
esbuild.config.mjs update eslint plugin version 2025-11-14 14:28:33 +01:00
eslint.config.mts update sample plugin with eslint instructions 2025-11-10 12:26:07 +01:00
LICENSE Add license, fixes #98 2025-01-27 21:38:01 +00:00
manifest.json 1.0.4 2026-04-23 02:03:26 -04:00
package-lock.json 1.0.4 2026-04-23 02:03:26 -04:00
package.json 1.0.4 2026-04-23 02:03:26 -04:00
README.md docs: note about matching watch folder in skill 2026-04-23 02:06:23 -04:00
tsconfig.json update eslint plugin version 2025-11-14 14:28:33 +01:00
version-bump.mjs build: only write new minAppVersion requirements to versions.json 2025-04-28 08:38:38 +02:00
versions.json Update for 0.15 2022-08-09 13:38:50 -04:00

README.md

Ingester

An Obsidian plugin that watches a folder for new clippings and automatically triggers Claude Code's /ingest skill.

https://github.com/user-attachments/assets/90a5f6c5-6be5-4d86-a85c-ad9765efc7cc

How It Works

  1. Obsidian Web Clipper is used to save an article to e.g raw/clippings/
  2. Plugin detects the new file
  3. Opens a new tmux window and runs claude "/ingest <path>"
  4. Claude Code processes the source into your wiki knowledge graph

Requirements

  • Claude Code CLI installed and in PATH
  • tmux running in your terminal
  • zsh shell (macOS default; Linux users may need to install)
  • The /ingest skill defined at .claude/skills/ingest/SKILL.md in your vault (see skills/ folder in this repo)

Installation

  1. Copy main.js, manifest.json, and styles.css to .obsidian/plugins/ingester/
  2. Enable "Ingester" in Settings > Community Plugins
  3. Configure the watch folder in plugin settings
  4. Copy skills/ingest/SKILL.md to .claude/skills/ingest/SKILL.md in your vault

Settings

Setting Default Description
Watch Folder raw/clippings Folder to monitor for new files
Auto-ingest true Automatically run /ingest when new files are detected

Note: The included /ingest skill expects sources in raw/clippings/. If you change the watch folder, update the path references in SKILL.md to match.

Disclosures

Account required: This plugin requires Claude Code CLI, which requires an Anthropic account and API access.

Network use: The plugin itself makes no network requests. However, when it invokes Claude Code, Claude Code connects to Anthropic's API servers to process your content. See Anthropic's Privacy Policy for details on data handling.

External program execution: This plugin executes external programs (tmux and claude) via Node.js child_process. It does not access files outside your Obsidian vault directly, but the invoked Claude Code session operates within your vault directory.

Desktop only: Requires desktop Obsidian due to dependency on system shell commands.

Development

npm install
npm run dev    # Watch mode
npm run build  # Production build