Skip to content

docs: bring the llms.txt and llms-full.txt headers in line with the CLI setup #667

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zantvoort merged 1 commit into from
Oct 9, 2026
Merged

docs: bring the llms.txt and llms-full.txt headers in line with the CLI setup #667

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions website/scripts/generate-llms-full.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,14 +147,23 @@ cat > "$OUTPUT" <<'HEADER'
> context, no transparent lazy loading, no proxy generation, and no entity state
> management, so the code is exactly what runs. The domain model gives one-line,
> type-safe queries across relations, returning the whole entity graph in one
> statement. The CLI installs rules and skills for coding
> agents, plus a local MCP server that exposes only schema metadata while
> keeping database credentials away from the LLM. Built-in verification
> (validateSchema(), SqlCapture) lets the agent check its own work before
> anything is committed.
> statement.
>
> For coding agents: the Storm CLI installs rules and skills for Claude Code,
> Cursor, GitHub Copilot, Windsurf and Codex. An existing rules file (such as
> CLAUDE.md) keeps its content; Storm adds its own marked block. Optionally it
> sets up an MCP server that runs locally and is read-only: it exposes schema
> metadata (table definitions, column types, constraints), never the database
> credentials, and row data only when the user enables it. Built-in
> verification (validateSchema(), SqlCapture) lets the agent check its own work
> before anything is committed.
>
> Get started (interactive, run by the user in a terminal; needs Node.js 18+):
> `npx @storm-orm/cli init` in an existing project, or `npx @storm-orm/cli demo`
> in an empty directory. Installed globally (`npm install -g @storm-orm/cli`),
> the same commands are `storm init` and `storm demo`; `storm update` refreshes
> rules and skills without prompts.
>
> Get started: `npx @storm-orm/cli init` (existing project) or
> `npx @storm-orm/cli demo` (empty directory)
> Website: https://orm.st
> GitHub: https://github.com/storm-orm/storm-framework
> License: Apache 2.0
Expand Down
19 changes: 12 additions & 7 deletions website/static/llms.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,19 @@
> statement.
>
> For coding agents: the Storm CLI installs rules and skills for Claude Code,
> Cursor, GitHub Copilot, Windsurf and Codex, plus an optional local MCP server
> that exposes schema metadata (table definitions, column types, constraints)
> while keeping database credentials away from the LLM. Built-in verification
> (validateSchema(), SqlCapture) lets the agent check its own work before
> anything is committed.
> Cursor, GitHub Copilot, Windsurf and Codex. An existing rules file (such as
> CLAUDE.md) keeps its content; Storm adds its own marked block. Optionally it
> sets up an MCP server that runs locally and is read-only: it exposes schema
> metadata (table definitions, column types, constraints), never the database
> credentials, and row data only when the user enables it. Built-in
> verification (validateSchema(), SqlCapture) lets the agent check its own work
> before anything is committed.
>
> Get started: `npx @storm-orm/cli init` (existing project) or
> `npx @storm-orm/cli demo` (empty directory)
> Get started (interactive, run by the user in a terminal; needs Node.js 18+):
> `npx @storm-orm/cli init` in an existing project, or `npx @storm-orm/cli demo`
> in an empty directory. Installed globally (`npm install -g @storm-orm/cli`),
> the same commands are `storm init` and `storm demo`; `storm update` refreshes
> rules and skills without prompts.

Website: https://orm.st
GitHub: https://github.com/storm-orm/storm-framework
Expand Down
Loading