shiva ai
Generate AI-friendly documentation context files.
Usage
bash
shiva ai [options]What It Does
shiva ai generates a set of markdown context files that AI tools (Claude, ChatGPT, Cursor, GitHub Copilot) can use to understand your server's codebase:
ai-context/server-overview.md— your server's installed modules and configai-context/contracts.md— all bound contracts and their implementationsai-context/custom-modules.md— documentation for your custom modulesai-context/llms.txt— an index pointing at all context files
Options
| Flag | Description |
|---|---|
--output <dir> | Output directory (default: ai-context/) |
--include-stubs | Include stub pages for unimplemented contracts |
--format llms | Output in llms.txt format |
Using the Output
Point your AI assistant at the generated files:
bash
# With Claude CLI
claude --context ai-context/llms.txt "Add a fishing minigame module"
# With Cursor
# Add ai-context/ to your .cursorrules contextThe Framework's llms.txt
The Shiva framework docs are also available at:
https://shivafw.dev/llms.txthttps://shivafw.dev/llms-full.txt