Skip to content

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 config
  • ai-context/contracts.md — all bound contracts and their implementations
  • ai-context/custom-modules.md — documentation for your custom modules
  • ai-context/llms.txt — an index pointing at all context files

Options

FlagDescription
--output <dir>Output directory (default: ai-context/)
--include-stubsInclude stub pages for unimplemented contracts
--format llmsOutput 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 context

The Framework's llms.txt

The Shiva framework docs are also available at:

  • https://shivafw.dev/llms.txt
  • https://shivafw.dev/llms-full.txt

Released under the MIT License.