78935ea820
* first commit * rrvideo v0.1.0 First version of rrvideo. 1. Use as a Node.JS lib. 2. Use as a CLI. Features are implemented via puppeteer, ffmpeg and rrweb-player. * add readme * update publish script * add node env in cli file and change package.json bin to same like README (#4) Co-authored-by: Xu Yinjie <xuyinjie@xiaobangtouzi.com> * release 0.2.0 * fix #6 avoid assign undefined to config * Fix: Solve the inconsistency between rrvideo and the real recorded page rendering when rendering the page with a headless browser (https://github.com/rrweb-io/rrvideo/pull/26) Author: xujiujiu <906784584@qq.com> --------- Co-authored-by: xujiujiu <906784584@qq.com> * refactor rrvideo 1. refactor code 2. change monorepo config 3. remove separate TS dependencies * add changeset * fix: eslint errors --------- Co-authored-by: Yanzhen Yu <yanzhen@smartx.com> Co-authored-by: xyj <593500664@qq.com> Co-authored-by: Xu Yinjie <xuyinjie@xiaobangtouzi.com> Co-authored-by: xujiujiu <906784584@qq.com>
38 lines
978 B
Markdown
38 lines
978 B
Markdown
# rrvideo
|
|
|
|
[中文文档](./README.zh_CN.md)
|
|
|
|
rrvideo is a tool for transforming the session recorded by [rrweb](https://github.com/rrweb-io/rrweb) into a video.
|
|
|
|
## Install rrvideo
|
|
|
|
1. Install [ffmpeg](https://ffmpeg.org/download.html)。
|
|
2. Install [Node.JS](https://nodejs.org/en/download/)。
|
|
3. Run `npm i -g rrvideo` to install the rrvideo CLI。
|
|
|
|
## Use rrvideo
|
|
|
|
### Transform a rrweb session(in JSON format) into a video.
|
|
|
|
```shell
|
|
rrvideo --input PATH_TO_YOUR_RRWEB_EVENTS_FILE
|
|
```
|
|
|
|
Running this command will output a `rrvideo-output.mp4` file in the current working directory.
|
|
|
|
### Config the output path
|
|
|
|
```shell
|
|
rrvideo --input PATH_TO_YOUR_RRWEB_EVENTS_FILE --output OUTPUT_PATH
|
|
```
|
|
|
|
### Config the replay
|
|
|
|
You can prepare a rrvideo config file and pass it to CLI.
|
|
|
|
```shell
|
|
rrvideo --input PATH_TO_YOUR_RRWEB_EVENTS_JSON_FILE --config PATH_TO_YOUR_RRVIDEO_CONFIG_FILE
|
|
```
|
|
|
|
You can find an example of the rrvideo config file [here](./rrvideo.config.example.json).
|