@liebstoeckel/cli 0.3.7

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 ADDED
@@ -0,0 +1,373 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ 1. Definitions
5
+ --------------
6
+
7
+ 1.1. "Contributor"
8
+ means each individual or legal entity that creates, contributes to
9
+ the creation of, or owns Covered Software.
10
+
11
+ 1.2. "Contributor Version"
12
+ means the combination of the Contributions of others (if any) used
13
+ by a Contributor and that particular Contributor's Contribution.
14
+
15
+ 1.3. "Contribution"
16
+ means Covered Software of a particular Contributor.
17
+
18
+ 1.4. "Covered Software"
19
+ means Source Code Form to which the initial Contributor has attached
20
+ the notice in Exhibit A, the Executable Form of such Source Code
21
+ Form, and Modifications of such Source Code Form, in each case
22
+ including portions thereof.
23
+
24
+ 1.5. "Incompatible With Secondary Licenses"
25
+ means
26
+
27
+ (a) that the initial Contributor has attached the notice described
28
+ in Exhibit B to the Covered Software; or
29
+
30
+ (b) that the Covered Software was made available under the terms of
31
+ version 1.1 or earlier of the License, but not also under the
32
+ terms of a Secondary License.
33
+
34
+ 1.6. "Executable Form"
35
+ means any form of the work other than Source Code Form.
36
+
37
+ 1.7. "Larger Work"
38
+ means a work that combines Covered Software with other material, in
39
+ a separate file or files, that is not Covered Software.
40
+
41
+ 1.8. "License"
42
+ means this document.
43
+
44
+ 1.9. "Licensable"
45
+ means having the right to grant, to the maximum extent possible,
46
+ whether at the time of the initial grant or subsequently, any and
47
+ all of the rights conveyed by this License.
48
+
49
+ 1.10. "Modifications"
50
+ means any of the following:
51
+
52
+ (a) any file in Source Code Form that results from an addition to,
53
+ deletion from, or modification of the contents of Covered
54
+ Software; or
55
+
56
+ (b) any new file in Source Code Form that contains any Covered
57
+ Software.
58
+
59
+ 1.11. "Patent Claims" of a Contributor
60
+ means any patent claim(s), including without limitation, method,
61
+ process, and apparatus claims, in any patent Licensable by such
62
+ Contributor that would be infringed, but for the grant of the
63
+ License, by the making, using, selling, offering for sale, having
64
+ made, import, or transfer of either its Contributions or its
65
+ Contributor Version.
66
+
67
+ 1.12. "Secondary License"
68
+ means either the GNU General Public License, Version 2.0, the GNU
69
+ Lesser General Public License, Version 2.1, the GNU Affero General
70
+ Public License, Version 3.0, or any later versions of those
71
+ licenses.
72
+
73
+ 1.13. "Source Code Form"
74
+ means the form of the work preferred for making modifications.
75
+
76
+ 1.14. "You" (or "Your")
77
+ means an individual or a legal entity exercising rights under this
78
+ License. For legal entities, "You" includes any entity that
79
+ controls, is controlled by, or is under common control with You. For
80
+ purposes of this definition, "control" means (a) the power, direct
81
+ or indirect, to cause the direction or management of such entity,
82
+ whether by contract or otherwise, or (b) ownership of more than
83
+ fifty percent (50%) of the outstanding shares or beneficial
84
+ ownership of such entity.
85
+
86
+ 2. License Grants and Conditions
87
+ --------------------------------
88
+
89
+ 2.1. Grants
90
+
91
+ Each Contributor hereby grants You a world-wide, royalty-free,
92
+ non-exclusive license:
93
+
94
+ (a) under intellectual property rights (other than patent or trademark)
95
+ Licensable by such Contributor to use, reproduce, make available,
96
+ modify, display, perform, distribute, and otherwise exploit its
97
+ Contributions, either on an unmodified basis, with Modifications, or
98
+ as part of a Larger Work; and
99
+
100
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
101
+ for sale, have made, import, and otherwise transfer either its
102
+ Contributions or its Contributor Version.
103
+
104
+ 2.2. Effective Date
105
+
106
+ The licenses granted in Section 2.1 with respect to any Contribution
107
+ become effective for each Contribution on the date the Contributor first
108
+ distributes such Contribution.
109
+
110
+ 2.3. Limitations on Grant Scope
111
+
112
+ The licenses granted in this Section 2 are the only rights granted under
113
+ this License. No additional rights or licenses will be implied from the
114
+ distribution or licensing of Covered Software under this License.
115
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
116
+ Contributor:
117
+
118
+ (a) for any code that a Contributor has removed from Covered Software;
119
+ or
120
+
121
+ (b) for infringements caused by: (i) Your and any other third party's
122
+ modifications of Covered Software, or (ii) the combination of its
123
+ Contributions with other software (except as part of its Contributor
124
+ Version); or
125
+
126
+ (c) under Patent Claims infringed by Covered Software in the absence of
127
+ its Contributions.
128
+
129
+ This License does not grant any rights in the trademarks, service marks,
130
+ or logos of any Contributor (except as may be necessary to comply with
131
+ the notice requirements in Section 3.4).
132
+
133
+ 2.4. Subsequent Licenses
134
+
135
+ No Contributor makes additional grants as a result of Your choice to
136
+ distribute the Covered Software under a subsequent version of this
137
+ License (see Section 10.2) or under the terms of a Secondary License (if
138
+ permitted under the terms of Section 3.3).
139
+
140
+ 2.5. Representation
141
+
142
+ Each Contributor represents that the Contributor believes its
143
+ Contributions are its original creation(s) or it has sufficient rights
144
+ to grant the rights to its Contributions conveyed by this License.
145
+
146
+ 2.6. Fair Use
147
+
148
+ This License is not intended to limit any rights You have under
149
+ applicable copyright doctrines of fair use, fair dealing, or other
150
+ equivalents.
151
+
152
+ 2.7. Conditions
153
+
154
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155
+ in Section 2.1.
156
+
157
+ 3. Responsibilities
158
+ -------------------
159
+
160
+ 3.1. Distribution of Source Form
161
+
162
+ All distribution of Covered Software in Source Code Form, including any
163
+ Modifications that You create or to which You contribute, must be under
164
+ the terms of this License. You must inform recipients that the Source
165
+ Code Form of the Covered Software is governed by the terms of this
166
+ License, and how they can obtain a copy of this License. You may not
167
+ attempt to alter or restrict the recipients' rights in the Source Code
168
+ Form.
169
+
170
+ 3.2. Distribution of Executable Form
171
+
172
+ If You distribute Covered Software in Executable Form then:
173
+
174
+ (a) such Covered Software must also be made available in Source Code
175
+ Form, as described in Section 3.1, and You must inform recipients of
176
+ the Executable Form how they can obtain a copy of such Source Code
177
+ Form by reasonable means in a timely manner, at a charge no more
178
+ than the cost of distribution to the recipient; and
179
+
180
+ (b) You may distribute such Executable Form under the terms of this
181
+ License, or sublicense it under different terms, provided that the
182
+ license for the Executable Form does not attempt to limit or alter
183
+ the recipients' rights in the Source Code Form under this License.
184
+
185
+ 3.3. Distribution of a Larger Work
186
+
187
+ You may create and distribute a Larger Work under terms of Your choice,
188
+ provided that You also comply with the requirements of this License for
189
+ the Covered Software. If the Larger Work is a combination of Covered
190
+ Software with a work governed by one or more Secondary Licenses, and the
191
+ Covered Software is not Incompatible With Secondary Licenses, this
192
+ License permits You to additionally distribute such Covered Software
193
+ under the terms of such Secondary License(s), so that the recipient of
194
+ the Larger Work may, at their option, further distribute the Covered
195
+ Software under the terms of either this License or such Secondary
196
+ License(s).
197
+
198
+ 3.4. Notices
199
+
200
+ You may not remove or alter the substance of any license notices
201
+ (including copyright notices, patent notices, disclaimers of warranty,
202
+ or limitations of liability) contained within the Source Code Form of
203
+ the Covered Software, except that You may alter any license notices to
204
+ the extent required to remedy known factual inaccuracies.
205
+
206
+ 3.5. Application of Additional Terms
207
+
208
+ You may choose to offer, and to charge a fee for, warranty, support,
209
+ indemnity or liability obligations to one or more recipients of Covered
210
+ Software. However, You may do so only on Your own behalf, and not on
211
+ behalf of any Contributor. You must make it absolutely clear that any
212
+ such warranty, support, indemnity, or liability obligation is offered by
213
+ You alone, and You hereby agree to indemnify every Contributor for any
214
+ liability incurred by such Contributor as a result of warranty, support,
215
+ indemnity or liability terms You offer. You may include additional
216
+ disclaimers of warranty and limitations of liability specific to any
217
+ jurisdiction.
218
+
219
+ 4. Inability to Comply Due to Statute or Regulation
220
+ ---------------------------------------------------
221
+
222
+ If it is impossible for You to comply with any of the terms of this
223
+ License with respect to some or all of the Covered Software due to
224
+ statute, judicial order, or regulation then You must: (a) comply with
225
+ the terms of this License to the maximum extent possible; and (b)
226
+ describe the limitations and the code they affect. Such description must
227
+ be placed in a text file included with all distributions of the Covered
228
+ Software under this License. Except to the extent prohibited by statute
229
+ or regulation, such description must be sufficiently detailed for a
230
+ recipient of ordinary skill to be able to understand it.
231
+
232
+ 5. Termination
233
+ --------------
234
+
235
+ 5.1. The rights granted under this License will terminate automatically
236
+ if You fail to comply with any of its terms. However, if You become
237
+ compliant, then the rights granted under this License from a particular
238
+ Contributor are reinstated (a) provisionally, unless and until such
239
+ Contributor explicitly and finally terminates Your grants, and (b) on an
240
+ ongoing basis, if such Contributor fails to notify You of the
241
+ non-compliance by some reasonable means prior to 60 days after You have
242
+ come back into compliance. Moreover, Your grants from a particular
243
+ Contributor are reinstated on an ongoing basis if such Contributor
244
+ notifies You of the non-compliance by some reasonable means, this is the
245
+ first time You have received notice of non-compliance with this License
246
+ from such Contributor, and You become compliant prior to 30 days after
247
+ Your receipt of the notice.
248
+
249
+ 5.2. If You initiate litigation against any entity by asserting a patent
250
+ infringement claim (excluding declaratory judgment actions,
251
+ counter-claims, and cross-claims) alleging that a Contributor Version
252
+ directly or indirectly infringes any patent, then the rights granted to
253
+ You by any and all Contributors for the Covered Software under Section
254
+ 2.1 of this License shall terminate.
255
+
256
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257
+ end user license agreements (excluding distributors and resellers) which
258
+ have been validly granted by You or Your distributors under this License
259
+ prior to termination shall survive termination.
260
+
261
+ ************************************************************************
262
+ * *
263
+ * 6. Disclaimer of Warranty *
264
+ * ------------------------- *
265
+ * *
266
+ * Covered Software is provided under this License on an "as is" *
267
+ * basis, without warranty of any kind, either expressed, implied, or *
268
+ * statutory, including, without limitation, warranties that the *
269
+ * Covered Software is free of defects, merchantable, fit for a *
270
+ * particular purpose or non-infringing. The entire risk as to the *
271
+ * quality and performance of the Covered Software is with You. *
272
+ * Should any Covered Software prove defective in any respect, You *
273
+ * (not any Contributor) assume the cost of any necessary servicing, *
274
+ * repair, or correction. This disclaimer of warranty constitutes an *
275
+ * essential part of this License. No use of any Covered Software is *
276
+ * authorized under this License except under this disclaimer. *
277
+ * *
278
+ ************************************************************************
279
+
280
+ ************************************************************************
281
+ * *
282
+ * 7. Limitation of Liability *
283
+ * -------------------------- *
284
+ * *
285
+ * Under no circumstances and under no legal theory, whether tort *
286
+ * (including negligence), contract, or otherwise, shall any *
287
+ * Contributor, or anyone who distributes Covered Software as *
288
+ * permitted above, be liable to You for any direct, indirect, *
289
+ * special, incidental, or consequential damages of any character *
290
+ * including, without limitation, damages for lost profits, loss of *
291
+ * goodwill, work stoppage, computer failure or malfunction, or any *
292
+ * and all other commercial damages or losses, even if such party *
293
+ * shall have been informed of the possibility of such damages. This *
294
+ * limitation of liability shall not apply to liability for death or *
295
+ * personal injury resulting from such party's negligence to the *
296
+ * extent applicable law prohibits such limitation. Some *
297
+ * jurisdictions do not allow the exclusion or limitation of *
298
+ * incidental or consequential damages, so this exclusion and *
299
+ * limitation may not apply to You. *
300
+ * *
301
+ ************************************************************************
302
+
303
+ 8. Litigation
304
+ -------------
305
+
306
+ Any litigation relating to this License may be brought only in the
307
+ courts of a jurisdiction where the defendant maintains its principal
308
+ place of business and such litigation shall be governed by laws of that
309
+ jurisdiction, without reference to its conflict-of-law provisions.
310
+ Nothing in this Section shall prevent a party's ability to bring
311
+ cross-claims or counter-claims.
312
+
313
+ 9. Miscellaneous
314
+ ----------------
315
+
316
+ This License represents the complete agreement concerning the subject
317
+ matter hereof. If any provision of this License is held to be
318
+ unenforceable, such provision shall be reformed only to the extent
319
+ necessary to make it enforceable. Any law or regulation which provides
320
+ that the language of a contract shall be construed against the drafter
321
+ shall not be used to construe this License against a Contributor.
322
+
323
+ 10. Versions of the License
324
+ ---------------------------
325
+
326
+ 10.1. New Versions
327
+
328
+ Mozilla Foundation is the license steward. Except as provided in Section
329
+ 10.3, no one other than the license steward has the right to modify or
330
+ publish new versions of this License. Each version will be given a
331
+ distinguishing version number.
332
+
333
+ 10.2. Effect of New Versions
334
+
335
+ You may distribute the Covered Software under the terms of the version
336
+ of the License under which You originally received the Covered Software,
337
+ or under the terms of any subsequent version published by the license
338
+ steward.
339
+
340
+ 10.3. Modified Versions
341
+
342
+ If you create software not governed by this License, and you want to
343
+ create a new license for such software, you may create and use a
344
+ modified version of this License if you rename the license and remove
345
+ any references to the name of the license steward (except to note that
346
+ such modified license differs from this License).
347
+
348
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
349
+ Licenses
350
+
351
+ If You choose to distribute Source Code Form that is Incompatible With
352
+ Secondary Licenses under the terms of this version of the License, the
353
+ notice described in Exhibit B of this License must be attached.
354
+
355
+ Exhibit A - Source Code Form License Notice
356
+ -------------------------------------------
357
+
358
+ This Source Code Form is subject to the terms of the Mozilla Public
359
+ License, v. 2.0. If a copy of the MPL was not distributed with this
360
+ file, You can obtain one at https://mozilla.org/MPL/2.0/.
361
+
362
+ If it is not possible or desirable to put the notice in a particular
363
+ file, then You may include the notice in a location (such as a LICENSE
364
+ file in a relevant directory) where a recipient would be likely to look
365
+ for such a notice.
366
+
367
+ You may add additional accurate notices of copyright ownership.
368
+
369
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
370
+ ---------------------------------------------------------
371
+
372
+ This Source Code Form is "Incompatible With Secondary Licenses", as
373
+ defined by the Mozilla Public License, v. 2.0.
package/README.md ADDED
@@ -0,0 +1,74 @@
1
+ # @liebstoeckel/cli
2
+
3
+ > The `liebstoeckel` command. Scaffold, develop, build, and present decks.
4
+
5
+ Part of [liebstoeckel](https://liebstoeckel.app), a code-first presentation framework. You write decks in MDX and TSX and build them into a single self-contained HTML file with no server or runtime dependencies. The same file works offline, and when you host it the deck runs a live session between the presenter and the audience. Built on Bun, React 19, Motion, and Tailwind v4.
6
+
7
+ > **Status: experimental, pre-1.0.** liebstoeckel is an evolving experiment, not yet production-ready. Before 1.0, breaking changes can land in any release without a major-version bump, so pin an exact version if you depend on it.
8
+
9
+ This is the umbrella CLI. One binary scaffolds a deck, runs a hot-reloading dev server, builds the single-file HTML, captures thumbnails, and drives live presenter mode.
10
+
11
+ ## Install
12
+
13
+ > It isn't on the public npm registry yet. The commands below are how it will install once it ships. For now, run it from a checkout of the repo (`bun run live|relay|thumbs …`) or from a workspace that links the packages.
14
+
15
+ ```sh
16
+ bun add -d @liebstoeckel/cli
17
+ # …or run it without installing:
18
+ bunx @liebstoeckel/cli <command>
19
+ ```
20
+
21
+ > Requires **Bun ≥ 1.3**.
22
+
23
+ ## Commands
24
+
25
+ ```sh
26
+ liebstoeckel new <name> # scaffold a new deck in ./<name>
27
+ liebstoeckel add <name>... # copy registry items (charts, …) into a deck as owned source
28
+ liebstoeckel registry list|view # browse the chart/component registry (--json for agents)
29
+ liebstoeckel build [dir] # build a deck into one self-contained .html (+ thumbnails)
30
+ liebstoeckel eject <deck.html> # recover a built deck's editable source
31
+ liebstoeckel pack [dir] # inspect or emit the source a build embeds
32
+ liebstoeckel licenses [dir] # report the third-party licenses bundled into a deck
33
+ liebstoeckel live <deck|dir> # present live (LAN, or through a --relay)
34
+ liebstoeckel relay # run a public relay server for WAN presenting
35
+ liebstoeckel thumbs <deck.html> # (re)generate thumbnails for a built deck
36
+ liebstoeckel export [deck|dir] # export slides to PNG or PDF
37
+ liebstoeckel skill install # install the agent skill for deck authoring
38
+ liebstoeckel login|push|orgs|decks|brand # liebstoeckel cloud (coming soon)
39
+
40
+ liebstoeckel <deck|dir> # shorthand for: liebstoeckel live <deck>
41
+ ```
42
+
43
+ There's no `dev` subcommand. For the hot-reloading dev server, run `bun run dev` inside the deck (the scaffold wires the script), or use `liebstoeckel live`.
44
+
45
+ The bin is installed as both `liebstoeckel` and the short alias `lst`. `live`, `relay`, `thumbs`, and `export` hand off to a sibling package; the rest are implemented here. Every command has its own `--help`. The authoritative command and flag reference lives at [docs.liebstoeckel.app/reference/cli](https://docs.liebstoeckel.app/reference/cli/).
46
+
47
+ ## Architecture
48
+
49
+ The CLI is a [citty](https://github.com/unjs/citty) dispatcher. `src/cli.ts` defines one root command whose `subCommands` are lazy `() => import(…)` thunks, so a command only pulls in what it needs. `build` never loads the live server, and `live` never loads the bundler. The CLI itself holds almost no logic. It routes, and each command module does the work or hands off to a sibling package.
50
+
51
+ | File | Role |
52
+ |---|---|
53
+ | `src/cli.ts` | The `liebstoeckel`/`lst` bin. It builds the root citty command, prints best-effort update and skill reminders, and resolves the bare-path shorthand (`liebstoeckel <deck>` becomes `live`) before calling `runMain`. |
54
+ | `src/targeting.ts` | `looksLikeDeck()` decides whether a leading positional is a deck path, so the shorthand kicks in instead of citty reporting an unknown command. |
55
+ | `src/new.ts` | `new` scaffolds a deck from a template (`index.html`, `main.tsx`, `build.ts`, `server.ts`, `bunfig.toml`, `slides/01-intro.tsx`) and bakes in the org's default brand when you're logged in. |
56
+ | `src/build.ts` | Holds `build`, `eject`, `pack`, and `licenses`. Each one calls into `@liebstoeckel/engine` or `@liebstoeckel/thumbnails`. |
57
+ | `src/add.ts`, `src/registry.ts` | Copy registry items into a deck as owned source, and browse the registry. |
58
+ | `src/skill.ts` | `skill install` and `skill update` write the version-pinned agent skill into a deck for each agent target. |
59
+ | `src/cloud.ts`, `src/creds.ts` | The cloud commands (`login` over the RFC 8628 device flow, plus `push`, `orgs`, `decks`, `brand`) and credential storage. |
60
+ | `src/update.ts` | The once-a-day update check and the "deck skill older than the CLI" reminder. Both write to stderr only, and stay quiet for `--json`, pipes, and CI. |
61
+
62
+ Where each command runs:
63
+
64
+ - Local commands are implemented in this package: `new`, `add`, `registry`, `skill`, the cloud commands, and `build`/`eject`/`pack`/`licenses`. `build` drives `buildDeck` from `@liebstoeckel/thumbnails/build`; `--check` uses `checkDeck`, `eject` and `pack` use `@liebstoeckel/engine/build/source-package`, and `licenses` reads `collectDeckLicenses` and `extractLicenses`.
65
+ - Delegated commands re-export a citty command straight out of a sibling package, so that package owns its own flags and `--help`: `live` (and the bare-deck shorthand) and `thumbs`/`export` come from `@liebstoeckel/live-server` and `@liebstoeckel/thumbnails`, and `relay` comes from `@liebstoeckel/present-relay`.
66
+
67
+ ## Links
68
+
69
+ - [CLI reference](https://docs.liebstoeckel.app/reference/cli/) lists every command and flag
70
+ - [Getting started](https://docs.liebstoeckel.app/guides/getting-started/)
71
+ - [Homepage](https://liebstoeckel.app)
72
+ - [Source and issues](https://github.com/liebstoeckel/liebstoeckel-app)
73
+
74
+ Licensed under [MPL-2.0](https://github.com/liebstoeckel/liebstoeckel-app/blob/main/LICENSE).
package/package.json ADDED
@@ -0,0 +1,60 @@
1
+ {
2
+ "name": "@liebstoeckel/cli",
3
+ "version": "0.3.7",
4
+ "description": "The liebstoeckel CLI to scaffold, develop, build, and present code-first decks.",
5
+ "keywords": [
6
+ "liebstoeckel",
7
+ "slides",
8
+ "presentation-slides",
9
+ "ai-agents",
10
+ "ai",
11
+ "skills",
12
+ "cli",
13
+ "mdx",
14
+ "react"
15
+ ],
16
+ "homepage": "https://liebstoeckel.app",
17
+ "bugs": "https://github.com/liebstoeckel/liebstoeckel-app/issues",
18
+ "repository": {
19
+ "type": "git",
20
+ "url": "git+https://github.com/liebstoeckel/liebstoeckel-app.git",
21
+ "directory": "packages/cli"
22
+ },
23
+ "license": "MPL-2.0",
24
+ "author": "Leon Kaucher <contact@liebstoeckel.app>",
25
+ "publishConfig": {
26
+ "access": "public"
27
+ },
28
+ "files": [
29
+ "src",
30
+ "!src/**/*.test.ts",
31
+ "!src/**/*.test.tsx",
32
+ "skill",
33
+ "LICENSE"
34
+ ],
35
+ "engines": {
36
+ "bun": ">=1.3"
37
+ },
38
+ "type": "module",
39
+ "bin": {
40
+ "liebstoeckel": "./src/cli.ts",
41
+ "lst": "./src/cli.ts"
42
+ },
43
+ "exports": {
44
+ ".": "./src/cli.ts",
45
+ "./new": "./src/new.ts"
46
+ },
47
+ "dependencies": {
48
+ "@liebstoeckel/engine": "^0.3.5",
49
+ "@liebstoeckel/live-server": "^0.3.5",
50
+ "@liebstoeckel/present-relay": "^0.3.5",
51
+ "@liebstoeckel/registry": "^0.3.4",
52
+ "@liebstoeckel/theme": "^0.3.3",
53
+ "@liebstoeckel/thumbnails": "^0.3.5",
54
+ "citty": "^0.2.2"
55
+ },
56
+ "peerDependencies": {
57
+ "react": "^19.2.7",
58
+ "react-dom": "^19.2.7"
59
+ }
60
+ }
@@ -0,0 +1,18 @@
1
+ <!-- liebstoeckel:start -->
2
+ ## Presentations (liebstoeckel)
3
+
4
+ This project builds presentation decks with **liebstoeckel** (code-first slides → one
5
+ self-contained HTML). To create or edit a deck, drive the `liebstoeckel` CLI:
6
+
7
+ - Discover charts: `liebstoeckel registry list --json`, then `liebstoeckel registry view <name> --json` for a component's exact `exports`, `props`, and `dataShape`.
8
+ - New deck: `liebstoeckel new <name> --dir presentations [--brand <brand>]` (creates `./presentations/<name>`; without `--dir`, `new` creates `./<name>` in the cwd).
9
+ - Scaffold a chart into a deck (owned source + deps): `liebstoeckel add <name> --dir <deck>`.
10
+ - Validate (run in a loop until `ok:true`): `liebstoeckel build --check --dir <deck>`.
11
+ - Build / export: `liebstoeckel build <deck>` · `liebstoeckel export <deck> --format pdf -o deck.pdf`.
12
+ - Live plugins (not in the registry): `bun add @liebstoeckel/plugin-poll` (or `-qa`/`-reactions`), register on `<Present plugins={[poll]}>`, place `<Plugin id="poll" props={{ … }} />`; present with `liebstoeckel live <deck>`.
13
+
14
+ Slides are MDX/TSX files in `<deck>/slides/`, listed in order in `main.tsx`; charts are
15
+ owned source in `<deck>/charts/`. Never invent component names or data shapes — read
16
+ them from `registry view`. Don't hand-write the final HTML; author slides and let
17
+ `build` render. Full guide: the `liebstoeckel-deck` skill, or https://docs.liebstoeckel.app/llms.txt
18
+ <!-- liebstoeckel:end -->
package/skill/SKILL.md ADDED
@@ -0,0 +1,144 @@
1
+ ---
2
+ name: liebstoeckel-deck
3
+ description: >-
4
+ Create and edit liebstoeckel presentation decks from source material (reports,
5
+ notes, data). Scaffolds a deck, adds visx chart components from the registry,
6
+ wires in real data, validates, and builds to a single self-contained HTML or
7
+ exports PNG/PDF. Use when the user asks to turn a document into slides, build or
8
+ edit a presentation/deck, add a chart to a slide, or mentions liebstoeckel.
9
+ metadata:
10
+ version: 0.0.0
11
+ license: MPL-2.0
12
+ ---
13
+
14
+ # General
15
+
16
+ - **Environment** — liebstoeckel is a framework written in Bun; it requires the **Bun
17
+ runtime** (not Node). Drive everything through the `liebstoeckel` CLI via bash.
18
+ - **Structure**
19
+ - A deck is authored as an **npm package** (its own `package.json`) of MDX/TSX slide
20
+ files.
21
+ - A deck compiles to **one self-contained `.html`** — JS, CSS, fonts, and assets all
22
+ inlined; no server, CDN, or runtime deps.
23
+ - That same `.html` **renders standalone** (open it directly, offline — plugins show a
24
+ fallback), or can be **hosted live** with
25
+ `liebstoeckel live [deck|dir|--dir <deck>] [opts]`, which enables the Yjs plugins
26
+ (poll, Q&A, reactions) for a full presenter/audience session.
27
+
28
+ # Authoring liebstoeckel decks
29
+
30
+ liebstoeckel is a code-first presentation framework: a deck is a project of
31
+ **MDX/TSX slide files** that builds to **one self-contained `.html`**. You author it
32
+ by writing slides and scaffolding chart components from a registry — the same code a
33
+ human writes. The `liebstoeckel` CLI does the scaffolding, building, and validating;
34
+ you write content and wire data. Drive everything through the CLI via bash.
35
+
36
+ **Always prefer the CLI's `--json` output** (it's the machine contract) and **run
37
+ `liebstoeckel build --check` in a loop until it passes** before declaring done — that
38
+ is your correctness signal.
39
+
40
+ ## Create a deck from a source document
41
+
42
+ 1. **See what charts exist** (do this first — never guess component names or data shapes):
43
+ ```bash
44
+ liebstoeckel registry list --json
45
+ ```
46
+ This returns every component with its `name`, `type`, and `dataShape`.
47
+
48
+ 2. **Scaffold the deck:**
49
+ ```bash
50
+ liebstoeckel new <name> --dir presentations [--brand <brand>] # creates ./presentations/<name>
51
+ # without --dir, `new` creates ./<name> in the current directory
52
+ ```
53
+
54
+ 3. **Outline the slides** from the source: a title, then one slide per key point.
55
+ Decide which points are best shown as a chart and what data each needs.
56
+
57
+ 4. **For every chart slide**, inspect the exact contract, scaffold it, then use it:
58
+ ```bash
59
+ liebstoeckel registry view bar-chart --json # exports, props, dataShape, example
60
+ liebstoeckel add bar-chart --dir ./presentations/<name>
61
+ ```
62
+ Then write a slide that imports the component (from where `add` wrote it) and passes
63
+ data **matching its `dataShape`** — see `references/components.md`.
64
+
65
+ The scaffolded `.tsx` is now **owned source in the deck** — it belongs to the deck,
66
+ not to a package. Passing data via props is the common path, but when the slide needs
67
+ something the props don't expose (a different palette, an extra series, an annotation,
68
+ dropping the legend, a layout or motion tweak), **edit `charts/<Name>.tsx` directly to
69
+ fit the use case.** That is the whole point of scaffolding owned source; don't work
70
+ around a chart's limits when you can change the chart.
71
+
72
+ 5. **Write prose slides** as MDX/TSX following `references/authoring.md`.
73
+
74
+ 6. **Validate and fix in a loop:**
75
+ ```bash
76
+ liebstoeckel build --check --dir ./presentations/<name> # JSON: { ok, diagnostics[] }
77
+ ```
78
+ If `ok` is false, fix each diagnostic (it carries `file`/`line`/`message`) and
79
+ re-run until `ok` is true.
80
+
81
+ 7. **Build or export:**
82
+ ```bash
83
+ liebstoeckel build ./presentations/<name> # → dist/<name>.html
84
+ liebstoeckel export ./presentations/<name> --format pdf -o deck.pdf
85
+ ```
86
+ Report the output path.
87
+
88
+ ## Edit an existing deck
89
+
90
+ Decks live under `presentations/<name>/` (or the project root). Slides are the files
91
+ in `slides/`, listed in order by the entry. To add/replace a slide, swap a chart, or
92
+ re-theme, see `references/editing.md`. Always finish with the `build --check` loop.
93
+
94
+ Only have a built `.html`? Recover the editable project first with
95
+ `liebstoeckel eject <deck.html> [outdir]`, then edit and rebuild as usual (details and
96
+ the rebuild's trust caveat in `references/editing.md`).
97
+
98
+ Building a deck runs its code on this machine, so a deck you did **not** scaffold here
99
+ is untrusted and `build`/`build --check` on it fails with an `untrusted deck` error.
100
+ **Never** pass `--trust` (or set `LIEBSTOECKEL_TRUST_BUILD=1`) on your own — relay the
101
+ trust question to the user and only proceed once they explicitly confirm. See the trust
102
+ note in `references/editing.md`.
103
+
104
+ ## Make a deck interactive (live plugins)
105
+
106
+ Plugins add live, synced audience interaction; offline the deck still builds and shows
107
+ a static fallback. They are **not in the registry** — don't `registry list` for them.
108
+ The built-ins:
109
+
110
+ - **poll** (`@liebstoeckel/plugin-poll`) — live voting; results update in real time.
111
+ - **qa** (`@liebstoeckel/plugin-qa`) — audience asks + upvotes questions from any slide;
112
+ presenter moderates.
113
+ - **reactions** (`@liebstoeckel/plugin-reactions`) — ephemeral floating emoji over the deck.
114
+
115
+ Adding one is: `bun add` the package, register it on `<Present plugins={[…]}>`, and place
116
+ `<Plugin id="…" props={…} />` on a slide — see `references/plugins.md`. To author a new
117
+ plugin, see `references/build-plugins.md`.
118
+
119
+ ## Rules
120
+
121
+ - **Never invent component names, props, or data shapes** — read them from
122
+ `registry list/view --json`. The registry is the source of truth.
123
+ - **Charts are owned source — adjust them to fit the use case.** After `add`, the
124
+ `.tsx` lives in the deck's `charts/` and is the deck's code, not a package API.
125
+ Prefer props for data, but freely edit the component itself (palette, series,
126
+ annotations, labels, layout, motion) whenever the slide needs it — re-running `add`
127
+ won't clobber your edits unless `--force`. Never import a chart from a package, and
128
+ never treat its props as a hard limit.
129
+ - **Don't hand-write the final HTML** — author slides + components; let `build` render.
130
+ - **Never trust a deck on the user's behalf.** Building runs the deck's code; if a
131
+ build fails with `untrusted deck`, do not blindly add `--trust` or
132
+ `LIEBSTOECKEL_TRUST_BUILD=1` — ask the user, and only proceed once they confirm.
133
+ - Keep going until `build --check` passes; that is the definition of done.
134
+
135
+ ## References
136
+
137
+ - `references/components.md` — component types in the registry, using scaffolded components/charts, data shapes, the `add` workflow.
138
+ - `references/authoring.md` — slide file conventions (MDX/TSX, notes, steps, layout, brands).
139
+ - `references/editing.md` — editing decks: add/replace slides, swap charts, re-theme, eject.
140
+ - `references/plugins.md` — add live plugins (poll/qa/reactions): register, place, present live.
141
+ - `references/build-plugins.md` — author a custom plugin (`definePlugin`, state, surfaces, server).
142
+ - `references/troubleshooting.md` — the `build --check` loop and common errors.
143
+
144
+ Full reference docs: https://docs.liebstoeckel.app/llms.txt