Basic Memory
Integrations

VS Code

Edit your Basic Memory knowledge base directly in VS Code with full IDE features and terminal CLI access

Edit your knowledge base directly in VS Code -- full syntax highlighting, markdown preview, and the Basic Memory CLI right in your terminal.

Cloud Sync Workflow

Basic Memory Cloud lets you edit locally in VS Code while keeping notes synced to the cloud.

Sign Up for Basic Memory Cloud

Create your account at app.basicmemory.com

Enable Cloud Mode

Authenticate and enable cloud mode:

bm cloud login

Set Up Sync

Install rclone and configure credentials:

bm cloud setup

This installs rclone automatically and configures your cloud credentials.

Sync requires the Basic Memory CLI. See Local Installation for setup.

Create Project with Local Sync

Point Basic Memory to your local workspace:

# For a project-specific docs folder
bm project add my-project --local-path ~/workspace/my-project/docs

# Or for a shared knowledge base
bm project add knowledge --local-path ~/Documents/knowledge

Establish Sync Baseline

Preview and run the initial sync:

# Preview first (recommended)
bm cloud bisync --name my-project --resync --dry-run

# Establish baseline
bm cloud bisync --name my-project --resync

Only use --resync for the first sync.

Edit in VS Code

Open your local directory in VS Code. Edit files with full IDE features -- syntax highlighting, markdown preview, split editors, and search all work out of the box.

Sync Changes

After editing locally or making changes in cloud, run bidirectional sync:

bm cloud bisync --name my-project

Changes flow both directions. Edit locally or in the cloud, both stay in sync.

Bidirectional sync: bisync keeps local and cloud in sync automatically. Newer files win conflicts. For one-way sync and advanced configuration, see the Cloud Sync Guide.

Local Setup

If you're running Basic Memory locally (no cloud), setup is simple:

# Install Basic Memory
uv tool install basic-memory

# Add a project pointing to a folder
bm project add my-project --local-path ~/workspace/my-project/docs

Then open that folder in VS Code. That's it -- your markdown files are the knowledge base. Every edit you make is automatically synced to the knowledge graph.


Try It

Edit Files Directly

VS Code is a first-class way to work with Basic Memory notes. Open any markdown file, edit it, save. Basic Memory watches for changes and updates the knowledge graph automatically.

Use split editors to view code on one side and documentation on the other. Use VS Code's built-in search to find content across your knowledge base.

Terminal CLI

Open VS Code's integrated terminal for quick operations:

# Search your knowledge base (including semantic search)
bm tool search-notes --query "authentication flow"
bm tool search-notes --query "how to handle errors" --search-type hybrid

# Check recent activity
bm tool recent-activity --timeframe "2 days"

# Write a quick note
bm tool write-note --title "API Design Decision" --folder "decisions"

Set up aliases in your shell profile (.bashrc, .zshrc, etc.) for faster access:

alias note="bm tool write-note"
alias search="bm tool search-notes --query"
alias recent="bm tool recent-activity"

Copilot Chat with MCP

VS Code's Copilot Chat now supports MCP servers. You can add Basic Memory as an MCP server in your VS Code settings and use it directly through Copilot -- search your knowledge base, write notes, and build context without leaving the chat panel. See the VS Code MCP documentation for setup details.


Troubleshooting

Sync not picking up changes? Check sync status with bm status and verify file permissions in your project directory.

Search missing results? VS Code's built-in search works for text matches. For knowledge graph queries and semantic search, use the CLI: bm tool search-notes --query "your query".

Cloud sync conflicts? Run bm cloud bisync --name my-project --dry-run to preview before syncing. See the Cloud Sync Guide for conflict resolution.


Next Steps

Project Documentation

Learn effective project documentation strategies.

Note Taking

Master note-taking techniques for development.

CLI Reference

Full Basic Memory command line reference.

Knowledge Format

Learn the semantic markdown format.