studioflow 0.1.1 → 0.1.2
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/README.md +89 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
# StudioFlow CLI
|
|
2
|
+
|
|
3
|
+
StudioFlow turns natural-language demo intent into deterministic UI run artifacts and executes them through Screen Studio.
|
|
4
|
+
|
|
5
|
+
## Requirements
|
|
6
|
+
|
|
7
|
+
- macOS (Screen Studio automation)
|
|
8
|
+
- Screen Studio installed
|
|
9
|
+
- Node.js 22+
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install -g studioflow
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Setup Runtime + Skills
|
|
18
|
+
|
|
19
|
+
`setup` installs Playwright Chromium, installs bundled skills for Codex and Claude, and checks permissions.
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
studioflow setup
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Bundled skills include:
|
|
26
|
+
- `studioflow-investigate` (intent -> deterministic artifacts, including `artifacts/flow.json`)
|
|
27
|
+
- `studioflow-cli` (artifact execution workflow)
|
|
28
|
+
|
|
29
|
+
## Quick Start
|
|
30
|
+
|
|
31
|
+
1. Start your agent from the project root.
|
|
32
|
+
|
|
33
|
+
Codex:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
cd /path/to/your/project
|
|
37
|
+
codex
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Claude Code:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
cd /path/to/your/project
|
|
44
|
+
claude
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
If your launcher command differs, start your usual Codex or Claude session in this repo root.
|
|
48
|
+
|
|
49
|
+
2. Trigger `studioflow-investigate` to generate `artifacts/flow.json`.
|
|
50
|
+
|
|
51
|
+
Paste this prompt:
|
|
52
|
+
|
|
53
|
+
```text
|
|
54
|
+
Use StudioFlow skill studioflow-investigate.
|
|
55
|
+
Intent: "Record a demo for onboarding and billing."
|
|
56
|
+
Generate artifacts/flow.json for this repo.
|
|
57
|
+
If intent details are missing, ask concise follow-up questions before authoring the flow.
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
`studioflow-investigate` automatically collects project context artifacts before creating the flow.
|
|
61
|
+
|
|
62
|
+
3. Validate and run:
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
studioflow validate --flow artifacts/flow.json
|
|
66
|
+
studioflow demo --flow artifacts/flow.json --intent "onboarding and billing demo"
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
`run`/`demo` automatically performs Screen Studio preflight checks. Use manual prep only for troubleshooting.
|
|
70
|
+
Headed runs auto-open a maximized browser window for cleaner recording composition.
|
|
71
|
+
Runs do not auto-export by default; include `recorder_export` in flow steps only when export is explicitly needed.
|
|
72
|
+
|
|
73
|
+
## Optional: Trigger Runtime Skill In Agent
|
|
74
|
+
|
|
75
|
+
If you want the agent to drive execution too, use:
|
|
76
|
+
|
|
77
|
+
```text
|
|
78
|
+
Use StudioFlow skill studioflow-cli.
|
|
79
|
+
Validate artifacts/flow.json, run the demo, and report run artifact paths.
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## Documentation
|
|
83
|
+
|
|
84
|
+
- Day 0 runbook: https://github.com/ydarar/studioflow/blob/main/docs/day0-runbook.md
|
|
85
|
+
- CLI reference: https://github.com/ydarar/studioflow/blob/main/docs/cli-reference.md
|
|
86
|
+
- Configuration: https://github.com/ydarar/studioflow/blob/main/docs/configuration.md
|
|
87
|
+
- Smoke checklist: https://github.com/ydarar/studioflow/blob/main/docs/testing-manual-smoke.md
|
|
88
|
+
- Open intent tests: https://github.com/ydarar/studioflow/blob/main/docs/studioflow-open-intent-tests.md
|
|
89
|
+
- Full docs map: https://github.com/ydarar/studioflow/blob/main/docs/README.md
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "studioflow",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Deterministic AI-assisted product demo automation CLI for Screen Studio workflows",
|
|
6
6
|
"type": "module",
|
|
@@ -33,8 +33,8 @@
|
|
|
33
33
|
"kleur": "^4.1.5",
|
|
34
34
|
"tsx": "^4.20.5",
|
|
35
35
|
"@studioflow/adapters-desktop": "0.1.0",
|
|
36
|
-
"@studioflow/adapters-playwright": "0.1.0",
|
|
37
36
|
"@studioflow/adapters-screenstudio": "0.1.0",
|
|
37
|
+
"@studioflow/adapters-playwright": "0.1.0",
|
|
38
38
|
"@studioflow/artifacts": "0.1.0",
|
|
39
39
|
"@studioflow/contracts": "0.1.0",
|
|
40
40
|
"@studioflow/flow-registry": "0.1.0",
|