@zaflun/lumio-agent-skill
v0.4.0
Published
AI agent skill files for building Lumio Extensions
Maintainers
Readme
@zaflun/lumio-agent-skill
AI coding assistant knowledge for building Lumio extensions. Installs reference files that teach Claude Code, GitHub Copilot, Cursor, Google Gemini, OpenAI Codex, and Windsurf how to use the Lumio SDK.
Installation
npx @zaflun/lumio-agent-skill addThis creates .lumio/skills/ in your project with reference docs, plus agent config files (GEMINI.md, AGENTS.md, .windsurfrules, .github/copilot-instructions.md) in your project root.
What gets installed
Skill Files (.lumio/skills/)
| File | Content |
|------|---------|
| SKILL.md | SDK overview, components, hooks, architecture |
| components.md | All 14 UI components with props |
| server-functions.md | Server function patterns, ctx API |
| cli-workflows.md | All 12 CLI commands |
| auth.md | Token types, permissions |
| runtime-scopes.md | Editor/layer/interactive surfaces |
| best-practices.md | Performance, security, UX |
| troubleshooting.md | Common errors and fixes |
Agent Config Files (project root)
| File | For |
|------|-----|
| GEMINI.md | Google Gemini CLI |
| AGENTS.md | OpenAI Codex / ChatGPT |
| .windsurfrules | Windsurf |
| .github/copilot-instructions.md | GitHub Copilot |
Claude Code reads .lumio/skills/SKILL.md automatically — no config file needed.
What your AI assistant learns
- 3-layer sandbox architecture (Supervisor → Runtime → Worker)
- 14 SDK components with typed props
- 10 hooks (
useLumioEvent,useLumioAction,useExtensionStorage, ...) - 49 event types across 5 platforms
- 21 action types (chat, OBS, Spotify, overlay)
- Server function patterns (declarative CRUD + handler-based)
- CLI workflows (init → dev → build → deploy)
- Publishing lifecycle (draft → review → testing → published)
Updating
npx @zaflun/lumio-agent-skill addRe-running overwrites skill files with the latest version. Safe to run multiple times.
Documentation
License
MIT © zaflun
