demoflow 0.0.0-stage → 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 +21 -0
- package/README.md +48 -2
- package/dist/bin/main.js +4442 -0
- package/fonts/Inter-Regular.ttf +0 -0
- package/fonts/Inter-SemiBold.ttf +0 -0
- package/fonts/OFL.txt +92 -0
- package/fonts/README.md +82 -0
- package/package.json +38 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Andriy
|
|
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
CHANGED
|
@@ -1,3 +1,49 @@
|
|
|
1
|
-
#
|
|
1
|
+
# demoflow
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Turn a scenario into a demo video. A scenario is a JSON file of steps —
|
|
4
|
+
navigate, click, fill, assert — that a real browser runs against your app while
|
|
5
|
+
it records; FFmpeg then renders the recording with captions and an end card.
|
|
6
|
+
|
|
7
|
+
## Requirements
|
|
8
|
+
|
|
9
|
+
Node.js 20 or newer, on Linux, macOS or Windows. Chromium is downloaded on
|
|
10
|
+
first use (about 250 MB, once); `demoflow setup` downloads it ahead of time.
|
|
11
|
+
On Linux, Chromium also needs its system libraries:
|
|
12
|
+
`npx playwright install-deps chromium`.
|
|
13
|
+
|
|
14
|
+
## Use
|
|
15
|
+
|
|
16
|
+
```sh
|
|
17
|
+
npx demoflow validate demoflow/login.demo.json
|
|
18
|
+
npx demoflow run demoflow/login.demo.json
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
A project has a `demoflow.config.json` at its root:
|
|
22
|
+
|
|
23
|
+
```json
|
|
24
|
+
{ "baseUrl": "http://localhost:3000" }
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
`demoflow run` prints where the video landed; `--json` prints the run result
|
|
28
|
+
as one JSON object instead.
|
|
29
|
+
|
|
30
|
+
| Command | What it does |
|
|
31
|
+
|---|---|
|
|
32
|
+
| `demoflow validate <scenario>` | check a scenario against the schema |
|
|
33
|
+
| `demoflow run <scenario>` | run it in a browser and render the video |
|
|
34
|
+
| `demoflow setup` | install Chromium now instead of on the first run |
|
|
35
|
+
| `demoflow mcp` | serve demo generation to MCP clients over stdio |
|
|
36
|
+
|
|
37
|
+
## With Claude Code
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
claude mcp add demoflow -- npx demoflow mcp
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
The server offers `generate_demo`, `get_task`, `cancel_task`,
|
|
44
|
+
`validate_scenario`, `list_demos` and `check_project`.
|
|
45
|
+
|
|
46
|
+
## Licence
|
|
47
|
+
|
|
48
|
+
MIT. The bundled Inter font files are under the SIL Open Font License 1.1 —
|
|
49
|
+
see `fonts/OFL.txt`.
|