75 lines
3.5 KiB
Markdown
75 lines
3.5 KiB
Markdown
<div align="center">
|
|
|
|
# Promptfire
|
|
|
|
[](https://obsidian.md)
|
|
[](https://www.typescriptlang.org/)
|
|
[](LICENSE)
|
|
[](package.json)
|
|
|
|
**Copy your vault's conventions, structure, and content to any LLM with a single hotkey.**
|
|
|
|
</div>
|
|
|
|
## The Problem
|
|
|
|
When working with AI assistants on your Obsidian vault, you constantly re-explain your folder structure, link style, tag conventions, and frontmatter requirements. This is repetitive, error-prone, and wastes tokens.
|
|
|
|
## The Solution
|
|
|
|
**Promptfire** stores your vault's conventions in a dedicated folder and copies everything to clipboard with one hotkey. Output adapts automatically for different LLMs (Claude, GPT-4, Gemini, etc.), and a built-in history tracks every context you generate.
|
|
|
|
## Key Features
|
|
|
|
- **Multi-LLM output targets** with per-model token limits, formats (XML, Markdown, Plain), and truncation strategies
|
|
- **Export profiles** for one-click multi-format export (e.g. XML for Claude + Markdown for ChatGPT + Plain for Gemini)
|
|
- **Smart context** that auto-detects related notes via links, tags, folder proximity, and shared properties
|
|
- **Prompt templates** with placeholders and conditionals for reusable workflows
|
|
- **Additional context sources** from freetext, external files, or shell commands
|
|
- **Frontmatter presets** to configure context per-note via `ai-context` YAML
|
|
- **Context diff** to copy only new and modified files since the last export
|
|
- **Context snapshots** for saving and replaying context recipes
|
|
- **Granular section selection** to include only the headings you need
|
|
- **Context history** with diff, search, and one-click restore
|
|
- **Context generator** that walks you through setting up vault conventions
|
|
|
|
See the [full documentation](docs/) for details on each feature.
|
|
|
|
## Quick Start
|
|
|
|
**1. Generate context files**
|
|
```
|
|
Ctrl+P > "Promptfire: Generate context files"
|
|
```
|
|
|
|
**2. Add output targets**
|
|
Settings > Promptfire > Output Targets > "Add Built-in Targets"
|
|
|
|
**3. Copy & paste**
|
|
```
|
|
Ctrl+P > "Promptfire: Copy context to clipboard"
|
|
```
|
|
Paste into Claude, ChatGPT, or any AI assistant.
|
|
|
|
## Documentation
|
|
|
|
| Topic | Description |
|
|
|-------|-------------|
|
|
| [Getting Started](docs/getting-started.md) | Installation, first run, commands |
|
|
| [Output Targets](docs/output-targets.md) | Multi-LLM formats, truncation, and export profiles |
|
|
| [Templates](docs/templates.md) | Prompt templates, placeholders, conditionals |
|
|
| [Context Sources](docs/context-sources.md) | Freetext, file, and shell sources |
|
|
| [Frontmatter Presets](docs/frontmatter-presets.md) | Per-note ai-context YAML configuration |
|
|
| [Section Selection](docs/section-selection.md) | Granular heading and block selection |
|
|
| [Smart Context](docs/smart-context.md) | Auto-detect related notes with context intelligence |
|
|
| [History & Snapshots](docs/history.md) | Context history, diff, restore, and snapshots |
|
|
| [Settings](docs/settings.md) | Full settings reference |
|
|
| [Advanced](docs/advanced.md) | Truncation strategies, priority order, XML format |
|
|
|
|
## Contributing
|
|
|
|
Contributions welcome! Fork the repo, create a feature branch, run `npm run build` to verify, and submit a pull request. Report bugs and request features via [GitHub Issues](https://github.com/tolvitty/obsidian-logfire/issues).
|
|
|
|
## License
|
|
|
|
MIT License - see [LICENSE](LICENSE) for details.
|