<2-3 sentences summarising what the project addresses and solves, the target audience, and the benefit.> IWE provides IDE-like power for Markdown-based Personal Knowledge Management (PKM) directly within developer text editors. It targets developers seeking a fast, local-first solution to organize and manage notes, offering advanced features typically found in code editors. The primary benefit is a seamless, efficient writing and knowledge retrieval experience integrated into existing workflows.

How It Works

This Rust-powered tool operates locally, ensuring data privacy and Git compatibility. It leverages the Language Server Protocol (LSP) to bring features like intelligent search, auto-completion, go-to-definition, and refactoring (e.g., extract/embed notes) to Markdown documents. IWE understands document structure via headers, lists, and links, supporting hierarchical organization through Maps of Content (MOCs) and wiki-style linking.

Quick Start & Requirements

Installation is available via Homebrew (brew install iwe) or Cargo (cargo install iwe iwes). After installation, initialize a workspace with iwe init in your notes directory. Editor integration requires specific configuration for supported editors like VS Code, Neovim, Zed, and Helix, with dedicated guides available. No non-default hardware or specific OS versions are listed as prerequisites for basic functionality.

Highlighted Details

• LSP Features: Offers comprehensive code-editor-like functionalities for Markdown, including note search, link navigation and auto-completion, hover previews, automated note creation via templates, seamless note extraction/inlining, document formatting, automatic link title updates, backlink searching, and text transformation via external commands (integrating with AI agents).
• CLI Utility: Provides a fast command-line interface for workspace initialization, document normalization, knowledge base analysis, exporting note structures as DOT graphs, and squashing multiple files into a single document.
• Agentic CLI Tools: Specialized commands for AI agents enable programmatic knowledge graph navigation, content retrieval with context, fuzzy document matching, and structured JSON output for complex workflows.

Maintenance & Community

IWE is community-driven, with contributions to code and documentation actively encouraged. Separate repositories host editor plugins for Neovim, VS Code, and Zed. Key contributors include Sergej Podatelew, Daniel Fichtinger, and Lowband21.

Licensing & Compatibility

The project is licensed under the Apache License 2.0, which is permissive for commercial use and integration into closed-source projects.

Limitations & Caveats

The README does not explicitly detail limitations. Editor integrations are managed in separate repositories, which may require users to track multiple projects for full functionality.