SpeakNotes
Get Started

Obsidian Plugin Documentation

Complete guide to installing, configuring, and using the SpeakNotes plugin for Obsidian.

InstallationCommandsSettingsHelp

Installation

Download the Plugin

Download the latest version of the SpeakNotes plugin for Obsidian.

Download Plugin

Install in Obsidian

  1. Open Obsidian and go to Settings → Community plugins
  2. Disable Safe Mode if prompted
  3. Click 'Install from file' or extract the downloaded zip to your vault's .obsidian/plugins/speaknotes folder
  4. Enable the SpeakNotes plugin in the Community plugins list

Enable the Plugin

After installation, make sure to enable the plugin in the Community plugins settings. You should see a microphone icon appear in your ribbon.

Getting Started

Connect Your SpeakNotes Account

  1. Open Settings → SpeakNotes
  2. Click 'Login with SpeakNotes'
  3. Sign in with your SpeakNotes account in the browser
  4. The plugin will automatically connect and start syncing

Note: You need a SpeakNotes account to use the plugin. Sign up at speaknotes.io if you don't have one.

Recording Voice Memos

Record voice memos directly in Obsidian. Your recordings are automatically uploaded to SpeakNotes for transcription and summarization.

How to Record

  1. Click the microphone icon in the ribbon, or use the command 'SpeakNotes: Record Voice Memo'
  2. Click 'Start Recording' and speak into your microphone
  3. Click 'Stop Recording' when finished
  4. Choose a title and summary format, then wait for processing

Recording Features

  • Real-time waveform visualization
  • Recording timer display
  • Choose from 14+ summary formats (notes, bullet points, meeting notes, etc.)

Syncing Your Library

Keep your Obsidian vault in sync with your SpeakNotes library. All your transcriptions and summaries can be exported as Markdown files.

Automatic Sync

Enable 'Auto Sync' in settings to automatically sync when Obsidian starts. You can also set a sync interval to keep your library updated throughout the day.

Manual Sync

Use the command 'SpeakNotes: Sync SpeakNotes Library' or click the sync button in the sidebar to manually sync at any time.

Folder Structure

Synced notes are saved to your configured export folder (default: 'SpeakNotes'). The plugin preserves your SpeakNotes folder structure in Obsidian.

Available Commands

Access all commands via the Command Palette (Ctrl/Cmd + P). All commands are prefixed with 'SpeakNotes:'.

SpeakNotes: Open SpeakNotes Library

Open the SpeakNotes library sidebar to browse and search your notes.

SpeakNotes: Record Voice Memo

Open the recording modal to capture a new voice memo.

SpeakNotes: Sync SpeakNotes Library

Manually sync your SpeakNotes library with your vault.

SpeakNotes: Export Current Note to SpeakNotes

Export the currently open note to SpeakNotes.

SpeakNotes: Bulk Export Notes

Export multiple notes from your vault to SpeakNotes at once.

SpeakNotes: Import Notes to SpeakNotes

Import notes from SpeakNotes into your vault.

SpeakNotes: Create Backlinks in SpeakNotes Notes

Scan SpeakNotes notes and create backlinks to related content in your vault.

SpeakNotes: Open SpeakNotes Graph View

View a visual graph of connections between your SpeakNotes notes.

Settings Reference

Connection Settings

  • Connected Account - Shows your connected SpeakNotes account email. Click 'Disconnect' to unlink.
  • Last Sync - Shows when your library was last synced. Click 'Sync Now' to trigger a manual sync.

Sync Settings

  • Export Folder - The folder in your vault where SpeakNotes files will be saved. Default is 'SpeakNotes'.
  • Auto Sync - Automatically sync your library when Obsidian starts.
  • Sync Interval - How often to sync in minutes. Set to 0 to disable periodic sync. Default is 30 minutes.

Content Settings

  • Default Summary Format - The default format used for new recordings (e.g., Note, Bullet Points, Meeting Notes).
  • Include Full Transcription - Whether to include the full transcription text in exported notes.
  • Export Template - Custom Markdown template for exported notes. Leave empty for the default template.

Export Templates

Customize how your SpeakNotes are formatted when exported to Obsidian. Use template variables to insert note data.

VariableDescription
{{id}}Unique SpeakNotes ID for the note
{{title}}Title of the note
{{created}}Date the note was created (ISO format)
{{updated}}Date the note was last updated (ISO format)
{{type}}Content type (audio, video, youtube, pdf)
{{status}}Processing status (Done, Processing, Error)
{{format}}Summary format (note, bullet-points, meeting-notes, etc.)
{{isPinned}}Whether the note is pinned (true/false)
{{summary}}The AI-generated summary content
{{transcription}}The full transcription text (if enabled in settings)

Example Template

---
speaknotes_id: {{id}}
created: {{created}}
updated: {{updated}}
type: {{type}}
tags: [speaknotes]
---

# {{title}}

## Summary

{{summary}}

## Transcription

{{transcription}}

Troubleshooting

Plugin won't connect to my account

Make sure you're signed into SpeakNotes in your browser. Try disconnecting and reconnecting in the plugin settings. Check that your browser allows popups from speaknotes.io.

Notes aren't syncing

Verify you're connected by checking the status bar. Only notes with 'Done' status will sync. Try a manual sync using the command palette. Check your export folder exists and is writable.

Recording fails to start

Ensure your browser/Obsidian has microphone permissions. Check that no other app is using the microphone. Try restarting Obsidian.

Some notes are missing after sync

Only completed notes (status: Done) are synced. Notes still processing will appear after they're finished. Check your folder filter in the sidebar.

Still having issues? Contact us at [email protected]

Ready to Get Started?

Download the plugin and start capturing audio content in Obsidian.

Download PluginLearn More