@zaflun/lumio-agent-skill 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +21 -0
- package/README.md +65 -0
- package/dist/bin/lumio-skills.d.ts +1 -0
- package/dist/bin/lumio-skills.js +31 -0
- package/dist/chunk-I2USQPPS.js +1729 -0
- package/dist/index.d.ts +16 -0
- package/dist/index.js +10 -0
- package/package.json +55 -0
package/LICENSE.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 zaflun
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# @zaflun/lumio-agent-skill
|
|
2
|
+
|
|
3
|
+
AI coding assistant knowledge for building [Lumio](https://lumio.vision) extensions. Installs reference files that teach Claude Code, GitHub Copilot, Cursor, Google Gemini, OpenAI Codex, and Windsurf how to use the Lumio SDK.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx @zaflun/lumio-agent-skill add
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
This 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.
|
|
12
|
+
|
|
13
|
+
## What gets installed
|
|
14
|
+
|
|
15
|
+
### Skill Files (`.lumio/skills/`)
|
|
16
|
+
|
|
17
|
+
| File | Content |
|
|
18
|
+
|------|---------|
|
|
19
|
+
| `SKILL.md` | SDK overview, components, hooks, architecture |
|
|
20
|
+
| `components.md` | All 14 UI components with props |
|
|
21
|
+
| `server-functions.md` | Server function patterns, ctx API |
|
|
22
|
+
| `cli-workflows.md` | All 12 CLI commands |
|
|
23
|
+
| `auth.md` | Token types, permissions |
|
|
24
|
+
| `runtime-scopes.md` | Editor/layer/interactive surfaces |
|
|
25
|
+
| `best-practices.md` | Performance, security, UX |
|
|
26
|
+
| `troubleshooting.md` | Common errors and fixes |
|
|
27
|
+
|
|
28
|
+
### Agent Config Files (project root)
|
|
29
|
+
|
|
30
|
+
| File | For |
|
|
31
|
+
|------|-----|
|
|
32
|
+
| `GEMINI.md` | Google Gemini CLI |
|
|
33
|
+
| `AGENTS.md` | OpenAI Codex / ChatGPT |
|
|
34
|
+
| `.windsurfrules` | Windsurf |
|
|
35
|
+
| `.github/copilot-instructions.md` | GitHub Copilot |
|
|
36
|
+
|
|
37
|
+
Claude Code reads `.lumio/skills/SKILL.md` automatically — no config file needed.
|
|
38
|
+
|
|
39
|
+
## What your AI assistant learns
|
|
40
|
+
|
|
41
|
+
- 3-layer sandbox architecture (Supervisor → Runtime → Worker)
|
|
42
|
+
- 14 SDK components with typed props
|
|
43
|
+
- 10 hooks (`useLumioEvent`, `useLumioAction`, `useExtensionStorage`, ...)
|
|
44
|
+
- 49 event types across 5 platforms
|
|
45
|
+
- 21 action types (chat, OBS, Spotify, overlay)
|
|
46
|
+
- Server function patterns (declarative CRUD + handler-based)
|
|
47
|
+
- CLI workflows (init → dev → build → deploy)
|
|
48
|
+
- Publishing lifecycle (draft → review → testing → published)
|
|
49
|
+
|
|
50
|
+
## Updating
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
npx @zaflun/lumio-agent-skill add
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Re-running overwrites skill files with the latest version. Safe to run multiple times.
|
|
57
|
+
|
|
58
|
+
## Documentation
|
|
59
|
+
|
|
60
|
+
- [AI Assistant Guide](https://developers.lumio.vision/guides/ai-assistant)
|
|
61
|
+
- [Full Docs](https://developers.lumio.vision)
|
|
62
|
+
|
|
63
|
+
## License
|
|
64
|
+
|
|
65
|
+
MIT © [zaflun](https://withzaflun.com)
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import {
|
|
3
|
+
installSkillFiles
|
|
4
|
+
} from "../chunk-I2USQPPS.js";
|
|
5
|
+
|
|
6
|
+
// src/bin/lumio-skills.ts
|
|
7
|
+
import { resolve } from "path";
|
|
8
|
+
var args = process.argv.slice(2);
|
|
9
|
+
var command = args[0];
|
|
10
|
+
if (command === "add") {
|
|
11
|
+
const targetDir = resolve(process.cwd());
|
|
12
|
+
console.log("Installing Lumio Extension skill files...");
|
|
13
|
+
installSkillFiles(targetDir);
|
|
14
|
+
console.log("");
|
|
15
|
+
console.log("Installed skill files to .lumio/skills/:");
|
|
16
|
+
console.log(" SKILL.md - Architecture overview + quick reference");
|
|
17
|
+
console.log(" components.md - All 14 SDK components with props + examples");
|
|
18
|
+
console.log(" server-functions.md - Declarative + handler-based server functions");
|
|
19
|
+
console.log(" cli-workflows.md - All 8 CLI commands with examples");
|
|
20
|
+
console.log(" auth.md - Token types, scopes, editorOnly");
|
|
21
|
+
console.log(" runtime-scopes.md - instance/overlay/account/global scopes");
|
|
22
|
+
console.log(" best-practices.md - Performance + UX patterns");
|
|
23
|
+
console.log(" troubleshooting.md - Common errors + fixes");
|
|
24
|
+
console.log("");
|
|
25
|
+
console.log("AI agents will automatically load these files for context.");
|
|
26
|
+
} else {
|
|
27
|
+
console.log("Usage: npx lumio-skills add");
|
|
28
|
+
console.log("");
|
|
29
|
+
console.log("Installs Lumio Extension SDK skill files for AI coding assistants.");
|
|
30
|
+
process.exit(1);
|
|
31
|
+
}
|