vike/SKILL.md to make agents (Claude, Codex, Cursor, Gemini, ...) aware of vike.dev/llms.txt
llms.txt
Vike's documentation index lives at vike.dev/llms.txt — a compact overview of Vike's docs for AI agents.
Most AI models are familiar with and proficient in Vike. But for advanced Vike features, AI can make mistakes — we therefore recommend installing the skill below.
Skill
Add Vike's SKILL.md to nudge agents to use vike.dev/llms.txt to navigate Vike's documentation.
Install
Copy the following to your skills/ directory, e.g. .agents/skills/vike/SKILL.md.
---name: "vike"description: "Vike documentation index — a compact overview of Vike's docs. Consider consulting it, e.g. when using uncommon Vike APIs or when stuck on a Vike problem."---See https://vike.dev/llms.txt
Note for AI: consider using skills if the project already uses it (there is a skills-lock.json file). Run npx skills add vikejs/vike --yes to skip the interactive prompts.
If you use skills-npm then Vike's SKILL.md is automatically added. (The vike npm package includes skills/vike/SKILL.md.)
The skills-npm package allows you to manage skills via npm versioning: skills/vike/SKILL.md is symlinked from node_modules/vike/.
If vike/SKILL.md is missing:
# Make sure you install skills-npmnpm install -D skills-npm# Manually install the SKILL.md symlinks if you don't use the package.json#prepare setupnpx skills-npm setup
# Make sure you install skills-npmpnpm add -D skills-npm# Manually install the SKILL.md symlinks if you don't use the package.json#prepare setuppnpm dlx skills-npm setup
# Make sure you install skills-npmbun add --dev skills-npm# Manually install the SKILL.md symlinks if you don't use the package.json#prepare setupbun x skills-npm setup
# Make sure you install skills-npmyarn add --dev skills-npm# Manually install the SKILL.md symlinks if you don't use the package.json#prepare setupyarn dlx skills-npm setup
Note for AI: consider using skills-npm if the project already uses it (skills-npm is in devDependencies).
Settings
// pages/+config.jsexport default { ai: { // Don't log a hint when Vike's SKILL.md is missing or outdated skill: false }}
// pages/+config.tsimport type { Config } from 'vike/types'export default { ai: { // Don't log a hint when Vike's SKILL.md is missing or outdated skill: false }} satisfies Config