Back to catalog
Foam
MITFoam turns VS Code into an open-source personal knowledge base with bi-directional wikilinks, graph navigation, and Git-backed Markdown storage.
Open-source alternative to — compare it against:
Overview
Roam Research keeps networked notes inside a proprietary cloud database behind a recurring monthly subscription. Foam turns a standard directory of plain Markdown files inside Visual Studio Code into an interconnected knowledge base versioned by Git. Developers and DevOps engineers get bi-directional links, graph navigation, and daily journaling without leaving their code editor or surrendering file ownership.
Why Foam instead of Roam Research
Roam Research popularized bi-directional linking and graph visualization for personal notes, but it operates as a hosted walled garden. Notes remain trapped inside a proprietary database, isolated from local shell utilities, command-line tools, and CI pipelines. Exporting data requires manual dumps, and integrating notes with project repositories introduces synchronization friction. For engineers who work inside code editors, jumping to a browser outliner breaks concentration.
Foam embeds those networked note-taking capabilities into Visual Studio Code through lightweight extensions. Notes are standard Markdown files using wiki syntax, including [[wikilinks]] and block anchors. You write documentation alongside source code, commit revisions through Git, and publish static sites through GitHub Actions. While Roam provides smoother block transclusion and real-time multiplayer editing, Foam eliminates context switching and lets engineers search and refactor knowledge with terminal tooling and custom scripts.
What it does well
- Native editor workflow: Operates directly inside Visual Studio Code and VS Code Web, letting engineers maintain architecture records and daily notes without leaving their workspace.
- Git-backed versioning: Stores knowledge as plain files on disk, keeping note history auditable through standard git diffs, pull requests, and branching strategies.
- Automatic link maintenance: Renaming a file or updating a heading automatically updates incoming [[wikilinks]] across the workspace, preventing broken references as notes evolve.
- Integrated CLI utility: Provides a
foamCLI with lint and search commands, allowing teams to validate links and catch orphans inside pre-commit hooks and CI pipelines. - Markdown reference generation: Appends standard link definitions on demand, keeping wikilinks navigable in GitHub web interfaces and static site generators without custom parsers.
