Foam CLI

Command-line interface for Foam knowledge management.

Installation

# Install from npm
npm install -g @time4peter/foam-cli

# Or using yarn
yarn global add @time4peter/foam-cli

Development Installation

# From the monorepo root
yarn install
yarn workspace foam-cli build

# Link globally for development
cd packages/foam-cli
npm link

Usage

Verify Wikilinks

Check for broken wikilinks in your Foam workspace:

foam-cli verify-links [options]

Options:

• -p, --path <path>: Path to the workspace directory (default: current directory)
• -e, --extensions <extensions>: File extensions to check, comma-separated (default: "md,mdx")
• --json: Output results as JSON
• --no-color: Disable colored output

Examples:

# Check current directory
foam-cli verify-links

# Check specific directory
foam-cli verify-links -p ~/my-foam-notes

# Check only .md files
foam-cli verify-links -e md

# Output as JSON for scripting
foam-cli verify-links --json

The command will:

• Scan all markdown files in the workspace
• Parse wikilinks in the format [[target]] or [[target|alias]]
• Check if the target files exist
• Report any broken links with their location

Exit codes:

• 0: All links are valid
• 1: Broken links were found or an error occurred