diff --git a/docs/ai-development.md b/docs/ai-development.md new file mode 100644 index 0000000000..6f2d114aad --- /dev/null +++ b/docs/ai-development.md @@ -0,0 +1,29 @@ +# Develop with AI + +SQLModel includes an official **agent skill**, bundled with the Python package, with guidance for the version installed in your project. + +## Install the skill + +After [installing SQLModel](install.md), run [Library Skills](https://library-skills.io/use/) from your project directory: + +```bash +uvx library-skills +``` + +Select the SQLModel skill and `.agents/skills` for Codex and most agents, or `.claude/skills` for Claude Code. You can select both. + +Your agent can then use the skill automatically when working on SQLModel code. + +### Install without prompts + +For agents and scripts, select the SQLModel skill without interactive prompts: + +```bash +uvx library-skills install --skill sqlmodel --yes +``` + +For Claude Code, add `--claude` to also install it in `.claude/skills`: + +```bash +uvx library-skills install --skill sqlmodel --yes --claude +``` diff --git a/docs/index.md b/docs/index.md index 3114f5bc2f..eb869b0c7a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -41,6 +41,8 @@ SQLModel is a library for interacting with