screenci 0.0.31 → 0.0.33
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 +3 -3
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +124 -69
- package/dist/cli.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/src/config.d.ts +1 -2
- package/dist/src/config.d.ts.map +1 -1
- package/dist/src/config.js +54 -8
- package/dist/src/config.js.map +1 -1
- package/dist/src/defaults.d.ts +0 -4
- package/dist/src/defaults.d.ts.map +1 -1
- package/dist/src/defaults.js +0 -4
- package/dist/src/defaults.js.map +1 -1
- package/dist/src/hide.d.ts +1 -0
- package/dist/src/hide.d.ts.map +1 -1
- package/dist/src/hide.js +6 -0
- package/dist/src/hide.js.map +1 -1
- package/dist/src/types.d.ts +3 -21
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/video.d.ts +1 -0
- package/dist/src/video.d.ts.map +1 -1
- package/dist/src/video.js +6 -0
- package/dist/src/video.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/skills/screenci/references/init.md +7 -6
|
@@ -6,8 +6,8 @@ Use `screenci init` to scaffold a new ScreenCI project.
|
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
8
|
npx screenci init
|
|
9
|
-
npx screenci init
|
|
10
|
-
npx screenci init
|
|
9
|
+
npx screenci init "My Project"
|
|
10
|
+
npx screenci init "My Project" --verbose
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
## What It Creates
|
|
@@ -15,14 +15,14 @@ npx screenci init my-project --verbose
|
|
|
15
15
|
`screenci init` creates a ready-to-run project containing:
|
|
16
16
|
|
|
17
17
|
```text
|
|
18
|
-
|
|
18
|
+
screenci/
|
|
19
19
|
screenci.config.ts
|
|
20
20
|
videos/
|
|
21
21
|
example.video.ts
|
|
22
22
|
Dockerfile
|
|
23
23
|
package.json
|
|
24
24
|
.gitignore
|
|
25
|
-
|
|
25
|
+
.github/workflows/screenci.yaml (optional)
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
## Requirements
|
|
@@ -33,6 +33,7 @@ my-project/
|
|
|
33
33
|
## Notes
|
|
34
34
|
|
|
35
35
|
- If no name is passed, the command prompts for one.
|
|
36
|
+
- The name is used as the ScreenCI project display name. Files are always created in `screenci/`.
|
|
36
37
|
- `--verbose` shows more setup output.
|
|
37
38
|
- After scaffolding, run `npm install`.
|
|
38
39
|
- The image is fetched on demand when you run `record` or `test`.
|
|
@@ -40,8 +41,8 @@ my-project/
|
|
|
40
41
|
## Typical Flow
|
|
41
42
|
|
|
42
43
|
```bash
|
|
43
|
-
npx screenci init
|
|
44
|
-
cd
|
|
44
|
+
npx screenci init "My Project"
|
|
45
|
+
cd screenci
|
|
45
46
|
npm install
|
|
46
47
|
npx screenci test # verify the video works
|
|
47
48
|
npx screenci record # capture the final recording
|