You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Save visualizations as a part of your team documentation to document workflow and prevent recurring issues
23
23
- Create static Git diagrams (jpg) or dynamic animated videos (mp4) to speed up content creation
24
24
- Help visual learners understand how Git commands work
25
+
- Combine with bundled command [git-dummy](https://github.com/initialcommit-com/git-dummy) to generate a dummy Git repo and then simulate operations on it
25
26
26
27
## Features
27
28
- Run a one-liner git-sim command in the terminal to generate a custom Git command visualization (.jpg) from your repo
- Generate an animated video (.mp4) instead of a static image using the `--animate` flag (note: significant performance slowdown, it is recommended to use `--low-quality` to speed up testing and remove when ready to generate presentation-quality video)
30
31
- Choose between dark mode (default) and light mode
31
32
- Specify output formats of either jpg, png, mp4, or webm
33
+
- Combine with bundled command [git-dummy](https://github.com/initialcommit-com/git-dummy) to generate a dummy Git repo and then simulate operations on it
32
34
- Animation only: Add custom branded intro/outro sequences if desired
33
35
- Animation only: Speed up or slow down animation speed as desired
Optional: If you don't have an existing Git repo to simulate commands on, use the bundled [git-dummy](https://github.com/initialcommit-com/git-dummy) command to generate a dummy Git repo with the desired number of branches and commits to simulate operations on with git-sim:
5) Simulated output will be created as a `.jpg` file. Output files are named using the subcommand executed combined with a timestamp, and by default are stored in a subdirectory called `git-sim_media/`. The location of this subdirectory is customizable using the command line flag `--media-dir=path/to/output`. Note that when the `--animate` global flag is used, render times will be much longer and a `.mp4` video output file will be produced.
65
81
66
82
6) For convenience, environment variables can be set for any global command-line option available in git-sim. All environment variables start with `git_sim_` followed by the name of the option.
0 commit comments