obsidian-promptfire/docs/getting-started.md
luca-tty bc31779651 docs: update README and docs for export profiles, smart context, and snapshots
- Add export profiles, smart context, and snapshots to README features
- Document export profiles workflow and edge cases in output-targets.md
- Add per-target outputPath and intelligence settings to settings.md
- Add smart-context.md for context intelligence documentation
- Restructure history.md to include snapshots section
- Add new commands to getting-started.md
- Update repo URLs to GitHub

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-11 14:27:32 +01:00

2.3 KiB

Getting Started

Installation

  1. Open Settings > Community Plugins
  2. Click Browse and search for "Promptfire"
  3. Click Install, then Enable

From Source

# Clone into your vault's plugins folder
cd /path/to/vault/.obsidian/plugins
git clone https://github.com/tolvitty/obsidian-logfire.git promptfire

# Install and build
cd promptfire
npm install
npm run build

# Enable in Obsidian Settings > Community Plugins

Development

npm run dev  # Watch mode with hot reload

Quick Start

1. Generate Context Files

Ctrl+P > "Promptfire: Generate context files"

The generator walks you through configuring your vault conventions:

Section Options
Language English, German
File Naming kebab-case, snake_case, camelCase, free
Link Style Wikilinks [[note]] or Markdown [note](path)
Tag Style Hierarchical #area/tag, Flat #tag, None
Frontmatter Required fields for all notes
Rules Custom conventions and forbidden actions
Structure Auto-detected folders with purpose descriptions
Templates Note templates with target folders

Click "Generate" and your context files are created instantly.

2. Add Built-in Targets

Go to Settings > Promptfire > Output Targets and click "Add Built-in Targets".

3. Copy Context

Ctrl+P > "Promptfire: Copy context to clipboard"

Or click the clipboard ribbon icon.

4. Paste into AI Chat

The context is now in your clipboard. Paste it into Claude, ChatGPT, or any AI assistant.

Commands

Command Description
Copy context to clipboard Copy all context files
Copy context with current note Copy context + active note
Copy context (select sections) Choose specific headings
Copy context from frontmatter preset Use note's ai-context config
Copy smart context Auto-detect related notes via links, tags, and properties
Export context (multi-target) One-click export using the active export profile
Generate context files Open the generator
View context history Browse past contexts
View context snapshots Browse saved context snapshots