Backend · Any LLM tool that fetches it
Bun & Elysia / Hono llms.txt
An llms.txt for a Bun & Elysia / Hono project: a short Markdown map of what it is and where the key docs and code live.
- Path
- llms.txt
- Loads
- Fetched on request
- Format
- Markdown index (.txt)
- Used by
- Any LLM tool that fetches it
What this file tells the agent
An llms.txt gives language models and agents a short Markdown map of your Bun & Elysia / Hono project: what it is and where the key docs and code live, so a tool that fetches it can go straight to the right files.
- Use Elysia's native t schema builder (powered by TypeBox) for request body, query, and parameter validation.
- Leverage native Bun.serve(), Bun.file(), and Bun.password instead of slow Node.js polyfills or external dependencies.
- Structure plugins using .use() and define explicit Eden Treaty contracts for frontend consumption.
- Handle application errors using Elysia .onError(({ code, error, set }) => ...) with typed error codes.
- Ensure zero unhandled promise rejections and use strict type inference for all endpoint responses.
Code to avoid, and what to write instead
The rule steers the agent away from the left and toward the right.
// Discouraged: Node.js bcrypt imports, unvalidated body, and Express paradigms
import bcrypt from "bcrypt";
app.post("/users", async (req: any, res: any) => {
const hash = await bcrypt.hash(req.body.password, 10);
res.json({ success: true });
});import { Elysia, t } from "elysia";
export const app = new Elysia()
.onError(({ code, set }) => {
if (code === "NOT_FOUND") {
set.status = 404;
return { ok: false, error: "Resource not found" };
}
})
.post(
"/api/users",
async ({ body, set }) => {
const hash = await Bun.password.hash(body.password);
set.status = 201;
return { ok: true, email: body.email };
},
{
body: t.Object({
email: t.String({ format: "email" }),
password: t.String({ minLength: 8 }),
}),
}
);Install it in one command
- 01
Go to your project root
The file goes at llms.txt, relative to the root.
- 02
Download the file
Run the command on the right. It downloads this preset and writes the file.
- 03
Make sure it gets used
Nothing loads llms.txt automatically. Serve it at your site root, or point agents to it from CLAUDE.md or AGENTS.md.
$ curl -fsSL "https://www.devscratchpad.tech/api/raw/llms-txt/bun-elysia" -o "llms.txt"
writes llms.txt
llms.txt
To write the file from your own code instead, use Read your code or Convert Legacy Rules in the editor above.
More for Bun & Elysia / Hono
Questions
- What is llms.txt?
- llms.txt is an open proposal for a short Markdown file that lists a project's key docs and links, so AI tools can find them without crawling every page.
- Where should llms.txt be deployed?
- At /llms.txt on your documentation site, or in your repository root. Tools read it when they fetch it; nothing loads it automatically.