@soederpop/luca 0.0.8 → 0.0.9
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/AGENTS.md +1 -0
- package/CLAUDE.md +1 -0
- package/docs/bootstrap/CLAUDE.md +2 -1
- package/docs/bootstrap/SKILL.md +14 -1
- package/package.json +1 -1
- package/src/commands/run.ts +4 -1
package/AGENTS.md
CHANGED
|
@@ -26,6 +26,7 @@ On the frontend the browser container is perfect for highly reactive, stateful w
|
|
|
26
26
|
- `luca describe diskCache`
|
|
27
27
|
- `luca describe` describe the container itself
|
|
28
28
|
- `luca describe servers` describe which servers are available
|
|
29
|
+
- `luca describe ui.banner` describe a specific method or getter on a helper
|
|
29
30
|
- the arguments to describe are pretty forgiving and permissive
|
|
30
31
|
|
|
31
32
|
**IMPORTANT NOTE** When trying to investigate features, clients, servers, etc, see if these tools can help you first instead of searching for files and reading them that way. If youw ant to understand what they do, vs how theyre actually implemented
|
package/CLAUDE.md
CHANGED
|
@@ -26,6 +26,7 @@ On the frontend the browser container is perfect for highly reactive, stateful w
|
|
|
26
26
|
- `luca describe diskCache`
|
|
27
27
|
- `luca describe` describe the container itself
|
|
28
28
|
- `luca describe servers` describe which servers are available
|
|
29
|
+
- `luca describe ui.banner` describe a specific method or getter on a helper
|
|
29
30
|
- the arguments to describe are pretty forgiving and permissive
|
|
30
31
|
|
|
31
32
|
**IMPORTANT NOTE** When trying to investigate features, clients, servers, etc, see if these tools can help you first instead of searching for files and reading them that way. If youw ant to understand what they do, vs how theyre actually implemented
|
package/docs/bootstrap/CLAUDE.md
CHANGED
|
@@ -15,6 +15,7 @@ The `luca` binary is available in the path. Key commands:
|
|
|
15
15
|
- `luca` — list available commands (built-in + project commands)
|
|
16
16
|
- `luca eval "expression"` — evaluate JS with the container in scope
|
|
17
17
|
- `luca describe <name>` — full docs for any feature, client, or server (e.g. `luca describe fs`)
|
|
18
|
+
- `luca describe <name>.<member>` — docs for a specific method or getter (e.g. `luca describe ui.banner`, `luca describe fs.readFile`)
|
|
18
19
|
- `luca describe features` — index of all available features (also: `clients`, `servers`)
|
|
19
20
|
- `luca serve` — start a local server using `endpoints/` folder
|
|
20
21
|
- `luca run script.ts` — run a script with the container
|
|
@@ -28,7 +29,7 @@ The `luca` binary is available in the path. Key commands:
|
|
|
28
29
|
|
|
29
30
|
## Learning the Framework
|
|
30
31
|
|
|
31
|
-
1. **Discover** — Run `luca describe features`, `luca describe clients`, `luca describe servers` to see what's available. Then `luca describe <name>` for full docs on any helper. This is your first move, always. (See `.claude/skills/luca-framework/SKILL.md` for the full mental model.)
|
|
32
|
+
1. **Discover** — Run `luca describe features`, `luca describe clients`, `luca describe servers` to see what's available. Then `luca describe <name>` for full docs on any helper, or `luca describe <name>.<member>` to drill into a specific method or getter. This is your first move, always. (See `.claude/skills/luca-framework/SKILL.md` for the full mental model.)
|
|
32
33
|
2. **Build** — Run `luca scaffold <type> --tutorial` before creating a new helper. It covers the full guide for that type.
|
|
33
34
|
3. **Prototype** — Use `luca eval "expression"` to test container code before wiring up full handlers. Reach for eval when you're stuck — it gives you full runtime access.
|
|
34
35
|
4. **Reference** — Browse `.claude/skills/luca-framework/references/api-docs/` for pre-generated API docs
|
package/docs/bootstrap/SKILL.md
CHANGED
|
@@ -36,6 +36,19 @@ luca describe express # full docs for the express server
|
|
|
36
36
|
luca describe git fs proc # multiple helpers in one shot
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
+
### Drill into a specific method or getter
|
|
40
|
+
|
|
41
|
+
Use dot notation to get docs for a single method or getter on any helper:
|
|
42
|
+
|
|
43
|
+
```shell
|
|
44
|
+
luca describe ui.banner # docs for the banner() method on ui
|
|
45
|
+
luca describe fs.readFile # docs for readFile() on fs
|
|
46
|
+
luca describe ui.colors # docs for the colors getter on ui
|
|
47
|
+
luca describe git.branch # docs for the branch getter on git
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
This shows the description, parameters, return type, and examples for just that member. If the member doesn't exist, it lists all available methods and getters on the helper.
|
|
51
|
+
|
|
39
52
|
### Get targeted documentation
|
|
40
53
|
|
|
41
54
|
You can filter to only the sections you need:
|
|
@@ -63,7 +76,7 @@ luca describe --help # full flag reference for describe
|
|
|
63
76
|
luca help scaffold # help for any command
|
|
64
77
|
```
|
|
65
78
|
|
|
66
|
-
**Use `luca describe` liberally.** It is the fastest, safest way to understand what the container provides. Every feature, client, and server is self-describing — if you know a name, describe will tell you everything about it.
|
|
79
|
+
**Use `luca describe` liberally.** It is the fastest, safest way to understand what the container provides. Every feature, client, and server is self-describing — if you know a name, describe will tell you everything about it. Use dot notation (`ui.banner`, `fs.readFile`) when you need docs on just one method or getter.
|
|
67
80
|
|
|
68
81
|
---
|
|
69
82
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@soederpop/luca",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.9",
|
|
4
4
|
"website": "https://luca.soederpop.com",
|
|
5
5
|
"description": "lightweight universal conversational architecture AKA Le Ultimate Component Architecture AKA Last Universal Common Ancestor, part AI part Human",
|
|
6
6
|
"author": "jon soeder aka the people's champ <jon@soederpop.com>",
|
package/src/commands/run.ts
CHANGED
|
@@ -173,7 +173,10 @@ async function runMarkdown(scriptPath: string, options: z.infer<typeof argsSchem
|
|
|
173
173
|
continue
|
|
174
174
|
}
|
|
175
175
|
|
|
176
|
-
if (meta && typeof meta === 'string' && meta.toLowerCase().includes('skip'))
|
|
176
|
+
if (meta && typeof meta === 'string' && meta.toLowerCase().includes('skip')) {
|
|
177
|
+
console.log(container.ui.markdown(['```' + lang, value, '```'].join('\n')))
|
|
178
|
+
continue
|
|
179
|
+
}
|
|
177
180
|
|
|
178
181
|
console.log(container.ui.markdown(['```' + lang, value, '```'].join('\n')))
|
|
179
182
|
|