ContextQMD
Back to Foam

Installation

docs/user/getting-started/installation.md

0.40.23.2 KB
Original Source

Installation

Getting started with Foam is straightforward. This guide will walk you through installing everything you need to begin your knowledge management journey.

Step 1: Install Visual Studio Code

Foam is built on VS Code, Microsoft's free, open-source code editor. You can download it at https://code.visualstudio.com/

Why VS Code?

VS Code provides:

  • Excellent Markdown editing capabilities
  • Rich extension ecosystem
  • Cross-platform compatibility
  • Integrated terminal and Git support
  • Customizable interface and shortcuts

To learn more about using VS Code with Foam, check [get-started-with-vscode]

Step 2: Install the Foam Extension

The Foam extension adds knowledge management superpowers to VS Code.

  1. Open VS Code
  2. Click the Extensions icon in the sidebar (or press Ctrl+Shift+X / Cmd+Shift+X)
  3. Search for "Foam" in the extensions marketplace
  4. Click "Install" on the official Foam extension by Foam Team
  5. Reload VS Code when prompted

What the Foam Extension Provides

  • Wikilink auto-completion and navigation
  • Backlink discovery and panel
  • Graph visualization
  • Powerful note template engine
  • Daily notes functionality

While Foam works on its own, it is focused on the networking aspect of your notes. You might want to install additional extensions to improve the editing experience or the functionality of your notes.

Useful Extensions

  • Markdown All in One - Rich Markdown editing features. Highly recommended.

Other extensions:

  • Spell Right - Spell checking for your notes
  • Paste Image - Easily insert images from clipboard
  • Todo Tree - Track TODO items across your workspace

Optional: Install the Foam CLI

The Foam CLI lets you work with your workspace from the terminal — search notes, manage tags, create daily notes, and more — without opening VS Code.

bash
npm install -g foam-cli

Once installed, run foam --help to see available commands, or see the [[cli|CLI documentation]] for details.

What's Next?

Now that Foam is installed, you're ready to:

  1. [first-workspace] - Set up your knowledge base structure
  2. [get-started-with-vscode] - Learn how to use VS Code for note taking
  3. [note-taking-in-foam] - Write your first Markdown notes
  4. [navigation] - Connect your thoughts with wikilinks
  5. [graph-view] - Visualize your knowledge network

Getting Help

If you encounter issues: