# Getting Started ## Installation ### From Community Plugins (Recommended) 1. Open **Settings > Community Plugins** 2. Click **Browse** and search for "Promptfire" 3. Click **Install**, then **Enable** ### From Source ```bash # Clone into your vault's plugins folder cd /path/to/vault/.obsidian/plugins git clone https://codeberg.org/luca-tty/obsidian-promptfire.git promptfire # Install and build cd promptfire npm install npm run build # Enable in Obsidian Settings > Community Plugins ``` ### Development ```bash 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 | | **Generate context files** | Open the generator | | **View context history** | Browse past contexts |