https://github.com/fireproof-storage/llms.txt
Documentation for LLMs to use Fireproof
https://github.com/fireproof-storage/llms.txt
codegen database llmstxt vibecoding
Last synced: 8 months ago
JSON representation
Documentation for LLMs to use Fireproof
- Host: GitHub
- URL: https://github.com/fireproof-storage/llms.txt
- Owner: fireproof-storage
- License: apache-2.0
- Created: 2025-02-25T05:20:58.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-03-21T13:38:03.000Z (9 months ago)
- Last Synced: 2025-03-21T14:53:44.910Z (9 months ago)
- Topics: codegen, database, llmstxt, vibecoding
- Homepage: https://use-fireproof.com/llms.txt
- Size: 105 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Better AI Coding with Fireproof: `llms.txt`
Fireproof is an open-source JavaScript database that works locally and syncs effortlessly to the cloud—no backend setup required. By including `llms.txt` in your prompts, AI models gain a deep understanding of Fireproof's API, allowing them to generate fully functional applications without extra backend configuration dependencies. Use this txt file in your prompts, and may be surprised how often your prompts become "one shots that work."
## 🚀 Why Use `llms.txt`?
AI-assisted development works best when the model understands the tools you're using. The `llms.txt` file enhances LLM-generated code by providing:
- **Comprehensive API documentation** for Fireproof
- **Best practices for data modeling** in a local-first environment
- **Pre-built examples** to ensure AI-generated code is runnable out-of-the-box
With this file, AI models can generate complete Fireproof-powered applications that work immediately—no backend, no SQL, just a simple, local JavaScript database.
## ⚡ Quick Start
### 🔹 In ChatGPT
Use our [specialized GPT assistant](https://chatgpt.com/g/g-67bd0ebe210081918561667c08662d03-vibe-coding-with-fireproof) for optimized AI coding with Fireproof.
### 🔹 With Any Other LLM
1. Copy the contents of [`llms.txt`](https://use-fireproof.com/llms.txt).
2. Paste it into your prompt before asking the model to generate code using Fireproof.
3. Watch as the AI produces a compact, working application with built-in Fireproof integration.
## 📜 How `llms.txt` Works
`llms.txt` acts as a structured reference, ensuring that LLMs understand how to interact with Fireproof databases effectively. It follows the `llms.txt` standard, which improves AI reasoning by providing essential documentation in a machine-readable format.
### 📖 What is `llms.txt`?
The `llms.txt` format was proposed by Jeremy Howard in 2024 as an AI-friendly documentation standard. Similar to `robots.txt` for search engines, `llms.txt` helps LLMs understand and utilize a project's API and best practices.
For more details, visit [llmstxt.org](https://llmstxt.org).
### See also:
In addition to [`llms.txt`](https://use-fireproof.com/llms.txt), we also provide [`llms-full.txt`](https://use-fireproof.com/llms-full.txt) and [`llms-mini.txt`](https://use-fireproof.com/llms-mini.txt), you should choose based on the context length of your model.
## 📚 Learn More
- 📖 [Fireproof Documentation](https://use-fireproof.com)
- 📝 [Fireproof Blog](https://fireproof.storage/blog)