git-sim


Namegit-sim JSON
Version 0.3.4 PyPI version JSON
download
home_pageNone
SummarySimulate Git commands on your own repos by generating an image (default) or video visualization depicting the command's behavior.
upload_time2024-04-16 17:33:18
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseGPL-2.0
keywords git sim simulation simulate git-simulate git-simulation git-sim manim animation gitanimation image video dryrun dry-run
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # git-sim
![git-sim-logo-with-tagline-1440x376p45](https://user-images.githubusercontent.com/49353917/232990611-58d0693f-69c0-45c8-b51d-cd540793d18c.gif)

[![GitHub license](https://img.shields.io/github/license/initialcommit-com/git-sim)](https://github.com/initialcommit-com/git-sim/blob/main/LICENSE)
[![GitHub tag](https://img.shields.io/github/v/release/initialcommit-com/git-sim)](https://img.shields.io/github/v/release/initialcommit-com/git-sim)
[![Downloads](https://static.pepy.tech/badge/git-sim)](https://pepy.tech/project/git-sim)
[![Contributors](https://img.shields.io/github/contributors/initialcommit-com/git-sim)](https://github.com/initialcommit-com/git-sim/graphs/contributors)
[![Share](https://img.shields.io/twitter/url?label=Share&url=https%3A%2F%2Ftwitter.com%2Finitcommit)](https://twitter.com/intent/tweet?text=Check%20out%20%23gitsim%20%2D%20a%20tool%20to%20visualize%20%23Git%20operations%20in%20your%20local%20repos%20with%20a%20single%20terminal%20command,%20by%20%40initcommit!%20https%3A%2F%2Fgithub%2Ecom%2Finitialcommit%2Dcom%2Fgit%2Dsim)

Visually simulate Git operations in your own repos with a single terminal command.

This generates an image (default) or video visualization depicting the Git command's behavior.

Command syntax is based directly on Git's command-line syntax, so using git-sim is as familiar as possible.

Example: `$ git-sim merge <branch>`
<br/><br/>
![git-sim-merge_04-22-23_21-04-32_cropped](https://user-images.githubusercontent.com/49353917/233821875-a7bb640d-10be-4433-a8fb-bd25646eeff4.jpg)

Check out the [git-sim release blog post](https://initialcommit.com/blog/git-sim) for the full scoop!

## Support git-sim
Git-Sim is Free and Open-Source Software (FOSS). Your support will help me work on it (and other Git projects) full time!
- [Sponsor Git-Sim on GitHub](https://github.com/sponsors/initialcommit-com)
- [Support Git-Sim via Patreon](https://patreon.com/user?u=92322459)

## Use cases
- Visualize Git commands to understand their effects on your repo before actually running them
- Prevent unexpected working directory and repository states by simulating before running
- Share visualizations (jpg/png image or mp4/webm video) of your Git commands with your team, or the world
- Save visualizations as a part of your team documentation to document workflow and prevent recurring issues
- Create static Git diagrams (jpg/png) or dynamic animated videos (mp4/webm) to speed up content creation
- Help visual learners understand how Git commands work
- 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

## Features
- Run a one-liner git-sim command in the terminal to generate a custom Git command visualization (.jpg) from your repo
- Supported commands: `add`, `branch`, `checkout`, `cherry-pick`, `clean`, `clone`, `commit`, `config`, `fetch`, `init`, `log`, `merge`, `mv`, `pull`, `push`, `rebase`, `remote`, `reset`, `restore`, `revert`, `rm`, `stash`, `status`, `switch`, `tag`
- 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)
- Color commits by parameter, such as author with the `--color-by=author` option
- Choose between dark mode (default) and light mode
- Specify output formats of either jpg, png, mp4, or webm
- 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
- Animation only: Add custom branded intro/outro sequences if desired
- Animation only: Speed up or slow down animation speed as desired

## Quickstart
Note: If you prefer to install git-sim with Docker, skip steps (1) and (2) here and jump to the [Docker installation](#docker-installation) section below, then come back here to step (3).

1) **Install Manim and its dependencies for your OS / environment:**
    - [Install Manim on Windows](https://docs.manim.community/en/stable/installation/windows.html)
    - [Install Manim on MacOS](https://docs.manim.community/en/stable/installation/macos.html)
    - [Install Manim on Linux](https://docs.manim.community/en/stable/installation/linux.html)
    - [Install Manim in Conda](https://docs.manim.community/en/stable/installation/conda.html)

2) Install `git-sim`:

```console
$ pip3 install git-sim
```

Note: For MacOS, it is recommended to **NOT** use the system Python to install Git-Sim, and instead use [Homebrew](https://brew.sh) to install a version of Python to work with Git-Sim. Virtual environments should work too.

3) Browse to the Git repository you want to simulate Git commands in:

```console
$ cd path/to/git/repo
```

4) Run the program:

```console
$ git-sim [global options] <subcommand> [subcommand options]
```

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:

```console
$ git-dummy --name="dummy-repo" --branches=3 --commits=10
$ cd dummy-repo
$ git-sim [global options] <subcommand> [subcommand options]
```

Or if you want to do it all in a single command:

```console
$ git-dummy --no-subdir --branches=3 --commits=10 && git-sim [global options] <subcommand> [subcommand options]
```

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.

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.

For example, the `--media-dir` option can be set as an environment variable like:

```console
$ export git_sim_media_dir=~/Desktop
```

Similarly, the `--speed` option can be set like:

```console
$ export git_sim_speed=2
```

Boolean flags can be set like:

```console
$ export git_sim_light_mode=true
```

In general:

```console
$ export git_sim_option_name=option_value
```

Explicitly specifying options at the command-line takes precedence over the corresponding environment variable values.

7) See global help for list of global options/flags and subcommands:

```console
$ git-sim -h
```

8) See subcommand help for list of options/flags for a specific subcommand:

```console
$ git-sim <subcommand> -h
```

## Requirements
* Python 3.7 or greater
* Pip (Package manager for Python)
* [Manim (Community version)](https://www.manim.community/)

## Commands
Basic usage is similar to Git itself - `git-sim` takes a familiar set of subcommands including "add", "branch", "checkout", "cherry-pick", "clean", "clone", "commit", "config", "fetch", "init", "log", "merge", "mv", "pull", "push", "rebase", "remote", "reset", "restore", "revert", "rm", "stash", "status", "switch", "tag" along with corresponding options.


```console
$ git-sim [global options] <subcommand> [subcommand options]
```

The `[global options]` apply to the overarching `git-sim` simulation itself, including:

`-n <number>`: Number of commits to display from each branch head.  
`--all`: Display all local branches in the log output.  
`--animate`: Instead of outputting a static image, animate the Git command behavior in a .mp4 video.  
`--color-by author`: Color commits by parameter, such as author.  
`--invert-branches`: Invert positioning of branches by reversing order of multiple parents where applicable.  
`--hide-merged-branches`: Hide commits from merged branches, i.e. only display mainline commits.  
`--media-dir`: The path at which to store the simulated output media files.  
`-d`: Disable the automatic opening of the image/video file after generation. Useful to avoid errors in console mode with no GUI.  
`--light-mode`: Use a light mode color scheme instead of default dark mode.  
`--reverse, -r`: Display commit history in the reverse direction.  
`--img-format`: Output format for the image file, i.e. `jpg` or `png`. Default output format is `jpg`.  
`--stdout`: Write raw image data to stdout while suppressing all other program output.  
`--output-only-path`: Only output the path to the generated media file to stdout. Useful for other programs to ingest.  
`--quiet, -q`: Suppress all output except errors.  
`--highlight-commit-messages`: Make commit message text bigger and bold, and hide commit ids.  
`--style`: Graphical style of the output image or animated video, i.e. `clean` (default) or `thick`.

Animation-only global options (to be used in conjunction with `--animate`):

`--video-format`: Output format for the video file, i.e. `mp4` or `webm`. Default output format is `mp4`.  
`--speed=n`: Set the multiple of animation speed of the output simulation, `n` can be an integer or float, default is 1.5.  
`--low-quality`: Render the animation in low quality to speed up creation time, recommended for non-presentation use.  
`--show-intro`: Add an intro sequence with custom logo and title.  
`--show-outro`: Add an outro sequence with custom logo and text.  
`--title=title`: Custom title to display at the beginning of the animation.  
`--logo=logo.png`: The path to a custom logo to use in the animation intro/outro.  
`--outro-top-text`: Custom text to display above the logo during the outro.  
`--outro-bottom-text`: Custom text to display below the logo during the outro.  
`--font`: Font family used to display rendered text.

The `[subcommand options]` are like regular Git options specific to the specified subcommand (see below for a full list).

The following is a list of Git commands that can be simulated and their corresponding options/flags.

### git add
Usage: `git-sim add <file 1> <file 2> ... <file n>`

- Specify one or more `<file>` as a *modified* working directory file, or an untracked file
- Simulated output will show files being moved to the staging area
- Note that simulated output will also show the most recent 5 commits on the active branch

![git-sim-add_01-05-23_22-07-40](https://user-images.githubusercontent.com/49353917/210940814-7e8dc318-6116-4e56-b415-bc547401a56a.jpg)

### git branch
Usage: `git-sim branch <new branch name>`

- Specify `<new branch name>` as the name of the new branch to simulate creation of
- Simulated output will show the newly create branch ref along with most recent 5 commits on the active branch

![git-sim-branch_01-05-23_22-13-17](https://user-images.githubusercontent.com/49353917/210941509-2a42a7a4-2168-4f62-913f-3f6fe74a0684.jpg)

### git checkout
Usage: `git-sim checkout [-b] <branch>`

- Checks out `<branch>` into the working directory, i.e. moves `HEAD` to the specified `<branch>`
- The `-b` flag creates a new branch with the specified name `<branch>` and checks it out, assuming it doesn't already exist

![git-sim-checkout_04-09-23_21-46-04](https://user-images.githubusercontent.com/49353917/230827836-e9f23a0e-2576-4716-b2fb-6327d3cf9b22.jpg)

### git cherry-pick
Usage: `git-sim cherry-pick <commit>`

- Specify `<commit>` as a ref (branch name/tag) or commit ID to cherry-pick onto the active branch
- Supports editing the cherry-picked commit message with: `$ git-sim cherry-pick <commit> -e "Edited commit message"`

![git-sim-cherry-pick_01-05-23_22-23-08](https://user-images.githubusercontent.com/49353917/210942811-fa5155b1-4c6f-4afc-bea2-d39b4cd594aa.jpg)

### git clean
Usage: `git-sim clean`

- Simulated output will show untracked files being deleted
- Since this is just a simulation, no need to specify `-i`, `-n`, `-f` as in regular Git
- Note that simulated output will also show the most recent 5 commits on the active branch

![git-sim-clean_04-09-23_22-05-54](https://user-images.githubusercontent.com/49353917/230830043-779e7230-f439-461a-a408-b19b263e86e4.jpg)

### git clone
Usage: `git-sim clone <url>`

- Clone the remote repo from `<url>` (web URL or filesystem path) to a new folder in the current directory
- Output will report if clone operation is successful and show log of local clone

![git-sim-clone_04-09-23_21-51-53](https://user-images.githubusercontent.com/49353917/230828521-80c8d2d1-2a31-46bb-aeed-746f0441c86e.jpg)

### git commit
Usage: `git-sim commit -m "Commit message"`

- Simulated output will show the new commit added to the tip of the active branch
- Specify a commit message with the `-m` option
- HEAD and the active branch will be moved to the new commit
- Simulated output will show files in the staging area being included in the new commit
- Supports amending the last commit with: `$ git-sim commit --amend -m "Amended commit message"`

![git-sim-commit_01-05-23_22-10-21](https://user-images.githubusercontent.com/49353917/210941149-d83677a1-3ab7-4880-bc0f-871b1f150087.jpg)

### git config
Usage: `git-sim config [--list] <section.option> <value>`

- Simulated output describes the specified configuration change
- Use `--list` or `-l` to display all configuration

![git-sim-config_04-16-24_08-34-34](https://github.com/initialcommit-com/git-sim/assets/49353917/c123e7a7-1fff-4f5c-b4a2-1e34ea2a4d80)

### git fetch
Usage: `git-sim fetch <remote> <branch>`

- Fetches the specified `<branch>` from the specified `<remote>` to the local repo

![git-sim-fetch_04-09-23_21-47-59](https://user-images.githubusercontent.com/49353917/230828090-acae8979-4097-43a8-96ea-525890e0e0a8.jpg)

### git init
Usage: `git-sim init`

- Simulated output describes the initialized `.git/` directory and it's contents

![git-sim-init_04-16-24_08-34-47](https://github.com/initialcommit-com/git-sim/assets/49353917/2abb1a4a-3022-4353-a828-2d337baa8383)

### git log
Usage: `git-sim log [-n <number>] [--all]`

- Simulated output will show the most recent 5 commits on the active branch by default
- Use `-n <number>` to set number of commits to display from each branch head
- Set `--all` to display all local branches in the log output

![git-sim-log_01-05-23_22-02-39](https://user-images.githubusercontent.com/49353917/210940300-aadd14c6-72ab-4529-a1be-b494ed5dd4c9.jpg)

### git merge
Usage: `git-sim merge <branch> [-m "Commit message"] [--no-ff]`

- Specify `<branch>` as the branch name to merge into the active branch
- If desired, specify a commit message with the `-m` option
- Simulated output will depict a fast-forward merge if possible
- Otherwise, a three-way merge will be depicted
- To force a merge commit when a fast-forward is possible, use `--no-ff`
- If merge fails due to merge conflicts, the conflicting files are displayed

![git-sim-merge_01-05-23_09-44-46](https://user-images.githubusercontent.com/49353917/210942030-c7229488-571a-4943-a1f4-c6e4a0c8ccf3.jpg)

### git mv
Usage: `git-sim mv <file> <new file>`

- Specify `<file>` as file to update name/path
- Specify `<new file>` as new name/path of file 
- Simulated output will show the name/path of the file being updated 
- Note that simulated output will also show the most recent 5 commits on the active branch

![git-sim-mv_04-09-23_22-05-13](https://user-images.githubusercontent.com/49353917/230829978-0a64dbe2-d974-4cef-9c6e-ed26e987342f.jpg)

### git pull
Usage: `git-sim pull [<remote> <branch>]`

- Pulls the specified `<branch>` from the specified `<remote>` to the local repo
- If `<remote>` and `<branch>` are not specified, the active branch is pulled from the default remote
- If merge conflicts occur, they are displayed in a table

![git-sim-pull_04-09-23_21-50-15](https://user-images.githubusercontent.com/49353917/230828298-455c0a9d-cf94-499e-9e35-623e7b218772.jpg)

### git push
Usage: `git-sim push [<remote> <branch>]`

- Pushes the specified `<branch>` to the specified `<remote>` and displays the local result
- If `<remote>` and `<branch>` are not specified, the active branch is pushed to the default remote
- If the push fails due to remote changes that don't exist in the local repo, a message is included telling the user to pull first, along with color coding which commits need to be pulled

![git-sim-push_04-21-23_13-41-57](https://user-images.githubusercontent.com/49353917/233731005-51fd7887-ae14-4ceb-a5d5-e5aed79e9fd8.jpg)

### git rebase
Usage: `git-sim rebase <new-base>`

- Specify `<new-base>` as the branch name to rebase the active branch onto

![git-sim-rebase_01-05-23_09-53-34](https://user-images.githubusercontent.com/49353917/210942598-4ff8d1e6-464d-48f3-afb9-f46f7ec4828c.jpg)

### git remote
Usage: `git-sim remote [add|rename|remove|get-url|set-url] [<remote>] [<url>]`

- Simulated output will show remotes being added, renamed, removed, modified as indicated
- Running `git-sim remote` with no options will list all existing remotes and their details  

![git-sim-remote_04-16-24_08-40-37](https://github.com/initialcommit-com/git-sim/assets/49353917/ebaff04c-d5b6-4691-97b3-60bb502ba444)

### git reset
Usage: `git-sim reset <reset-to> [--mixed|--soft|--hard]`

- Specify `<reset-to>` as any commit id, branch name, tag, or other ref to simulate reset to from the current HEAD (default: `HEAD`)
- As with a normal git reset command, default reset mode is `--mixed`, but can be specified using `--soft`, `--hard`, or `--mixed`
- Simulated output will show branch/HEAD resets and resulting state of the working directory, staging area, and whether any file changes would be deleted by running the actual command

![git-sim-reset_01-05-23_22-15-49](https://user-images.githubusercontent.com/49353917/210941835-80f032d2-4f06-4032-8dd0-98c8a2569049.jpg)

### git restore
Usage: `git-sim restore <file 1> <file 2> ... <file n>`

- Specify one or more `<file>` as a *modified* working directory file, or staged file
- Simulated output will show files being moved back to the working directory or discarded changes
- Note that simulated output will also show the most recent 5 commits on the active branch

![git-sim-restore_01-05-23_22-09-14](https://user-images.githubusercontent.com/49353917/210941009-e6bf7271-ce9b-4e41-9a0b-24cc4b8d3b15.jpg)

### git revert
Usage: `git-sim revert <to-revert>`

- Specify `<to-revert>` as any commit id, branch name, tag, or other ref to simulate revert for
- Simulated output will show the new commit which reverts the changes from `<to-revert>`
- Simulated output will include the next 4 most recent commits on the active branch

![git-sim-revert_01-05-23_22-16-59](https://user-images.githubusercontent.com/49353917/210941979-6db8b55c-2881-41d8-9e2e-6263b1dece13.jpg)

### git rm
Usage: `git-sim rm <file 1> <file 2> ... <file n>`

- Specify one or more `<file>` as a *tracked* file
- Simulated output will show files being removed from Git tracking
- Note that simulated output will also show the most recent 5 commits on the active branch

![git-sim-rm_04-09-23_22-01-29](https://user-images.githubusercontent.com/49353917/230829899-f5d688ea-bc8e-46f9-a54a-55d251c8915d.jpg)

### git stash
Usage: `git-sim stash [push|pop|apply] <file>`

- Specify one or more `<file>` as a *modified* working directory file, or staged file
- If no `<file>` is specified, all available files will be included
- Simulated output will show files being moved in/out of the Git stash
- Note that simulated output will also show the most recent 5 commits on the active branch

![git-sim-stash_01-05-23_22-11-18](https://user-images.githubusercontent.com/49353917/210941254-69c80b63-5c06-411a-a36a-1454b2906ee8.jpg)

### git status
Usage: `git-sim status`

- Simulated output will show the state of the working directory, staging area, and untracked files
- Note that simulated output will also show the most recent 5 commits on the active branch

![git-sim-status_01-05-23_22-06-28](https://user-images.githubusercontent.com/49353917/210940685-735665e2-fa12-4043-979c-54c295b13800.jpg)

### git switch
Usage: `git-sim switch [-c] <branch>`

- Switches the checked-out branch to `<branch>`, i.e. moves `HEAD` to the specified `<branch>`
- The `-c` flag creates a new branch with the specified name `<branch>` and switches to it, assuming it doesn't already exist

![git-sim-switch_04-09-23_21-42-43](https://user-images.githubusercontent.com/49353917/230827783-a8740ace-b66f-4cac-b94e-5d101d27e0b5.jpg)

### git tag
Usage: `git-sim tag <new tag name>`

- Specify `<new tag name>` as the name of the new tag to simulate creation of
- Simulated output will show the newly create tag ref along with most recent 5 commits on the active branch

![git-sim-tag_01-05-23_22-14-18](https://user-images.githubusercontent.com/49353917/210941647-79376ff7-2941-42b3-964a-b1d3a404a4fe.jpg)

## Video animation examples
```console
$ git-sim --animate reset HEAD^
```

https://user-images.githubusercontent.com/49353917/210943230-f38d879b-bb0d-4d42-a196-f24efb9e351a.mp4

```console
$ git checkout main
$ git-sim --animate merge dev
```

https://user-images.githubusercontent.com/49353917/210943418-22c2cd11-be96-41bc-b621-7018eebc6bc0.mp4

```console
$ git checkout dev
$ git-sim --animate rebase main
```

https://user-images.githubusercontent.com/49353917/210943815-4b8be2da-18da-4c42-927a-61cf9a22834e.mp4

```console
$ git checkout main
$ git-sim --animate cherry-pick dev
```

https://user-images.githubusercontent.com/49353917/210944001-77bd0130-306b-40a8-ba0b-22e50172802b.mp4

## Basic command examples
Simulate the output of the git log command:

```console
$ cd path/to/git/repo
$ git-sim log
```

Simulate the output of the git status command:

```console
$ git-sim status
```

Simulate adding a file to the Git staging area:

```console
$ git-sim add filename.ext
```

Simulate restoring a file from the Git staging area:

```console
$ git-sim restore filename.ext
```

Simulate creating a new commit based on currently staged changes:

```console
$ git-sim commit -m "Commit message"
```

Simulate stashing all working directory and staged changes:

```console
$ git-sim stash
```

Simulate creating a new Git branch:

```console
$ git-sim branch new-branch-name
```

Simulate creating a new Git tag:

```console
$ git-sim tag new-tag-name
```

Simulate a hard reset of the current branch HEAD to the previous commit:

```console
$ git-sim reset HEAD^ --hard
```

Simulate reverting the changes in an older commit:

```console
$ git-sim revert HEAD~7
```

Simulate merging a branch into the active branch:

```console
$ git-sim merge feature1
```

Simulate rebasing the active branch onto a new base:

```console
$ git-sim rebase main
```

Simulate cherry-picking a commit from another branch onto the active branch:

```console
$ git-sim cherry-pick 0ae641
```

## Command examples with extra options/flags
Use light mode for white background and black text, instead of the default black background with white text:

```console
$ git-sim --light-mode status
```

Animate the simulated output as a .mp4 video file:

```console
$ git-sim --animate add filename.ext
```

Add an intro and outro with custom text and logo (must include `--animate`):

```console
$ git-sim --animate --show-intro --show-outro --outro-top-text="My Git Repo" --outro-bottom-text="Thanks for watching!" --logo=path/to/logo.png status
```

Customize the output image/video directory location:

```console
$ git-sim --media-dir=path/to/output status
```

Optionally, set the environment variable `git_sim_media_dir` to set a global default media directory, to be used if no `--media-dir` is provided. Simulated output images/videos will be placed in this location, in subfolders named with the corresponding repo's name.

```console
$ export git_sim_media_dir=path/to/media/directory
$ git-sim status
```
Note: `--media-dir` takes precedence over the environment variable. If you set the environment variable and still provide the argument, you'll find the media in the path provided by `--media-dir`.

Generate output video in low quality to speed up rendering time (useful for repeated testing, must include `--animate`):

```console
$ git-sim --animate --low-quality status
```

## Installation
See **Quickstart** section for details on installing manim and other dependencies. Then run:

```console
$ pip3 install git-sim
```

## Docker installation

1) Clone down the git-sim repository:

```console
$ git clone https://github.com/initialcommit-com/git-sim.git
```

2) Browse into the `git-sim` folder and build the Docker image:

```console
$ docker build -t git-sim .
```

3) Run git-sim commands as follows:
    - Windows: `docker run --rm -v %cd%:/usr/src/git-sim git-sim [global options] <subcommand> [subcommand options]`
    - MacOS / Linux: `docker run --rm -v $(pwd):/usr/src/git-sim git-sim [global options] <subcommand> [subcommand options]`
    
Optional: On MacOS / Linux / or GitBash in Windows, create an alias for the long docker command so your can run it as a normal `git-sim` command. To do so add the following line to your `.bashrc` or equivalent, then restart your terminal:

```bash
git-sim() { docker run --rm -v $(pwd):/usr/src/git-sim git-sim "$@"; }
```

This will enable you to run git-sim subcommands as [described above](#commands).

## Learn More
Learn more about this tool on the [git-sim project page](https://initialcommit.com/tools/git-sim).

## Authors
**Jacob Stopak** - on behalf of [Initial Commit](https://initialcommit.com)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "git-sim",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "git, sim, simulation, simulate, git-simulate, git-simulation, git-sim, manim, animation, gitanimation, image, video, dryrun, dry-run",
    "author": null,
    "author_email": "Jacob Stopak <jacob@initialcommit.io>",
    "download_url": "https://files.pythonhosted.org/packages/e6/40/5ccfbd10130b460087b771808b70ad48536a6b5cfa0094bcef6d1af74492/git_sim-0.3.4.tar.gz",
    "platform": null,
    "description": "# git-sim\r\n![git-sim-logo-with-tagline-1440x376p45](https://user-images.githubusercontent.com/49353917/232990611-58d0693f-69c0-45c8-b51d-cd540793d18c.gif)\r\n\r\n[![GitHub license](https://img.shields.io/github/license/initialcommit-com/git-sim)](https://github.com/initialcommit-com/git-sim/blob/main/LICENSE)\r\n[![GitHub tag](https://img.shields.io/github/v/release/initialcommit-com/git-sim)](https://img.shields.io/github/v/release/initialcommit-com/git-sim)\r\n[![Downloads](https://static.pepy.tech/badge/git-sim)](https://pepy.tech/project/git-sim)\r\n[![Contributors](https://img.shields.io/github/contributors/initialcommit-com/git-sim)](https://github.com/initialcommit-com/git-sim/graphs/contributors)\r\n[![Share](https://img.shields.io/twitter/url?label=Share&url=https%3A%2F%2Ftwitter.com%2Finitcommit)](https://twitter.com/intent/tweet?text=Check%20out%20%23gitsim%20%2D%20a%20tool%20to%20visualize%20%23Git%20operations%20in%20your%20local%20repos%20with%20a%20single%20terminal%20command,%20by%20%40initcommit!%20https%3A%2F%2Fgithub%2Ecom%2Finitialcommit%2Dcom%2Fgit%2Dsim)\r\n\r\nVisually simulate Git operations in your own repos with a single terminal command.\r\n\r\nThis generates an image (default) or video visualization depicting the Git command's behavior.\r\n\r\nCommand syntax is based directly on Git's command-line syntax, so using git-sim is as familiar as possible.\r\n\r\nExample: `$ git-sim merge <branch>`\r\n<br/><br/>\r\n![git-sim-merge_04-22-23_21-04-32_cropped](https://user-images.githubusercontent.com/49353917/233821875-a7bb640d-10be-4433-a8fb-bd25646eeff4.jpg)\r\n\r\nCheck out the [git-sim release blog post](https://initialcommit.com/blog/git-sim) for the full scoop!\r\n\r\n## Support git-sim\r\nGit-Sim is Free and Open-Source Software (FOSS). Your support will help me work on it (and other Git projects) full time!\r\n- [Sponsor Git-Sim on GitHub](https://github.com/sponsors/initialcommit-com)\r\n- [Support Git-Sim via Patreon](https://patreon.com/user?u=92322459)\r\n\r\n## Use cases\r\n- Visualize Git commands to understand their effects on your repo before actually running them\r\n- Prevent unexpected working directory and repository states by simulating before running\r\n- Share visualizations (jpg/png image or mp4/webm video) of your Git commands with your team, or the world\r\n- Save visualizations as a part of your team documentation to document workflow and prevent recurring issues\r\n- Create static Git diagrams (jpg/png) or dynamic animated videos (mp4/webm) to speed up content creation\r\n- Help visual learners understand how Git commands work\r\n- 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\r\n\r\n## Features\r\n- Run a one-liner git-sim command in the terminal to generate a custom Git command visualization (.jpg) from your repo\r\n- Supported commands: `add`, `branch`, `checkout`, `cherry-pick`, `clean`, `clone`, `commit`, `config`, `fetch`, `init`, `log`, `merge`, `mv`, `pull`, `push`, `rebase`, `remote`, `reset`, `restore`, `revert`, `rm`, `stash`, `status`, `switch`, `tag`\r\n- 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)\r\n- Color commits by parameter, such as author with the `--color-by=author` option\r\n- Choose between dark mode (default) and light mode\r\n- Specify output formats of either jpg, png, mp4, or webm\r\n- 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\r\n- Animation only: Add custom branded intro/outro sequences if desired\r\n- Animation only: Speed up or slow down animation speed as desired\r\n\r\n## Quickstart\r\nNote: If you prefer to install git-sim with Docker, skip steps (1) and (2) here and jump to the [Docker installation](#docker-installation) section below, then come back here to step (3).\r\n\r\n1) **Install Manim and its dependencies for your OS / environment:**\r\n    - [Install Manim on Windows](https://docs.manim.community/en/stable/installation/windows.html)\r\n    - [Install Manim on MacOS](https://docs.manim.community/en/stable/installation/macos.html)\r\n    - [Install Manim on Linux](https://docs.manim.community/en/stable/installation/linux.html)\r\n    - [Install Manim in Conda](https://docs.manim.community/en/stable/installation/conda.html)\r\n\r\n2) Install `git-sim`:\r\n\r\n```console\r\n$ pip3 install git-sim\r\n```\r\n\r\nNote: For MacOS, it is recommended to **NOT** use the system Python to install Git-Sim, and instead use [Homebrew](https://brew.sh) to install a version of Python to work with Git-Sim. Virtual environments should work too.\r\n\r\n3) Browse to the Git repository you want to simulate Git commands in:\r\n\r\n```console\r\n$ cd path/to/git/repo\r\n```\r\n\r\n4) Run the program:\r\n\r\n```console\r\n$ git-sim [global options] <subcommand> [subcommand options]\r\n```\r\n\r\nOptional: 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:\r\n\r\n```console\r\n$ git-dummy --name=\"dummy-repo\" --branches=3 --commits=10\r\n$ cd dummy-repo\r\n$ git-sim [global options] <subcommand> [subcommand options]\r\n```\r\n\r\nOr if you want to do it all in a single command:\r\n\r\n```console\r\n$ git-dummy --no-subdir --branches=3 --commits=10 && git-sim [global options] <subcommand> [subcommand options]\r\n```\r\n\r\n5) 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.\r\n\r\n6) 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.\r\n\r\nFor example, the `--media-dir` option can be set as an environment variable like:\r\n\r\n```console\r\n$ export git_sim_media_dir=~/Desktop\r\n```\r\n\r\nSimilarly, the `--speed` option can be set like:\r\n\r\n```console\r\n$ export git_sim_speed=2\r\n```\r\n\r\nBoolean flags can be set like:\r\n\r\n```console\r\n$ export git_sim_light_mode=true\r\n```\r\n\r\nIn general:\r\n\r\n```console\r\n$ export git_sim_option_name=option_value\r\n```\r\n\r\nExplicitly specifying options at the command-line takes precedence over the corresponding environment variable values.\r\n\r\n7) See global help for list of global options/flags and subcommands:\r\n\r\n```console\r\n$ git-sim -h\r\n```\r\n\r\n8) See subcommand help for list of options/flags for a specific subcommand:\r\n\r\n```console\r\n$ git-sim <subcommand> -h\r\n```\r\n\r\n## Requirements\r\n* Python 3.7 or greater\r\n* Pip (Package manager for Python)\r\n* [Manim (Community version)](https://www.manim.community/)\r\n\r\n## Commands\r\nBasic usage is similar to Git itself - `git-sim` takes a familiar set of subcommands including \"add\", \"branch\", \"checkout\", \"cherry-pick\", \"clean\", \"clone\", \"commit\", \"config\", \"fetch\", \"init\", \"log\", \"merge\", \"mv\", \"pull\", \"push\", \"rebase\", \"remote\", \"reset\", \"restore\", \"revert\", \"rm\", \"stash\", \"status\", \"switch\", \"tag\" along with corresponding options.\r\n\r\n\r\n```console\r\n$ git-sim [global options] <subcommand> [subcommand options]\r\n```\r\n\r\nThe `[global options]` apply to the overarching `git-sim` simulation itself, including:\r\n\r\n`-n <number>`: Number of commits to display from each branch head.  \r\n`--all`: Display all local branches in the log output.  \r\n`--animate`: Instead of outputting a static image, animate the Git command behavior in a .mp4 video.  \r\n`--color-by author`: Color commits by parameter, such as author.  \r\n`--invert-branches`: Invert positioning of branches by reversing order of multiple parents where applicable.  \r\n`--hide-merged-branches`: Hide commits from merged branches, i.e. only display mainline commits.  \r\n`--media-dir`: The path at which to store the simulated output media files.  \r\n`-d`: Disable the automatic opening of the image/video file after generation. Useful to avoid errors in console mode with no GUI.  \r\n`--light-mode`: Use a light mode color scheme instead of default dark mode.  \r\n`--reverse, -r`: Display commit history in the reverse direction.  \r\n`--img-format`: Output format for the image file, i.e. `jpg` or `png`. Default output format is `jpg`.  \r\n`--stdout`: Write raw image data to stdout while suppressing all other program output.  \r\n`--output-only-path`: Only output the path to the generated media file to stdout. Useful for other programs to ingest.  \r\n`--quiet, -q`: Suppress all output except errors.  \r\n`--highlight-commit-messages`: Make commit message text bigger and bold, and hide commit ids.  \r\n`--style`: Graphical style of the output image or animated video, i.e. `clean` (default) or `thick`.\r\n\r\nAnimation-only global options (to be used in conjunction with `--animate`):\r\n\r\n`--video-format`: Output format for the video file, i.e. `mp4` or `webm`. Default output format is `mp4`.  \r\n`--speed=n`: Set the multiple of animation speed of the output simulation, `n` can be an integer or float, default is 1.5.  \r\n`--low-quality`: Render the animation in low quality to speed up creation time, recommended for non-presentation use.  \r\n`--show-intro`: Add an intro sequence with custom logo and title.  \r\n`--show-outro`: Add an outro sequence with custom logo and text.  \r\n`--title=title`: Custom title to display at the beginning of the animation.  \r\n`--logo=logo.png`: The path to a custom logo to use in the animation intro/outro.  \r\n`--outro-top-text`: Custom text to display above the logo during the outro.  \r\n`--outro-bottom-text`: Custom text to display below the logo during the outro.  \r\n`--font`: Font family used to display rendered text.\r\n\r\nThe `[subcommand options]` are like regular Git options specific to the specified subcommand (see below for a full list).\r\n\r\nThe following is a list of Git commands that can be simulated and their corresponding options/flags.\r\n\r\n### git add\r\nUsage: `git-sim add <file 1> <file 2> ... <file n>`\r\n\r\n- Specify one or more `<file>` as a *modified* working directory file, or an untracked file\r\n- Simulated output will show files being moved to the staging area\r\n- Note that simulated output will also show the most recent 5 commits on the active branch\r\n\r\n![git-sim-add_01-05-23_22-07-40](https://user-images.githubusercontent.com/49353917/210940814-7e8dc318-6116-4e56-b415-bc547401a56a.jpg)\r\n\r\n### git branch\r\nUsage: `git-sim branch <new branch name>`\r\n\r\n- Specify `<new branch name>` as the name of the new branch to simulate creation of\r\n- Simulated output will show the newly create branch ref along with most recent 5 commits on the active branch\r\n\r\n![git-sim-branch_01-05-23_22-13-17](https://user-images.githubusercontent.com/49353917/210941509-2a42a7a4-2168-4f62-913f-3f6fe74a0684.jpg)\r\n\r\n### git checkout\r\nUsage: `git-sim checkout [-b] <branch>`\r\n\r\n- Checks out `<branch>` into the working directory, i.e. moves `HEAD` to the specified `<branch>`\r\n- The `-b` flag creates a new branch with the specified name `<branch>` and checks it out, assuming it doesn't already exist\r\n\r\n![git-sim-checkout_04-09-23_21-46-04](https://user-images.githubusercontent.com/49353917/230827836-e9f23a0e-2576-4716-b2fb-6327d3cf9b22.jpg)\r\n\r\n### git cherry-pick\r\nUsage: `git-sim cherry-pick <commit>`\r\n\r\n- Specify `<commit>` as a ref (branch name/tag) or commit ID to cherry-pick onto the active branch\r\n- Supports editing the cherry-picked commit message with: `$ git-sim cherry-pick <commit> -e \"Edited commit message\"`\r\n\r\n![git-sim-cherry-pick_01-05-23_22-23-08](https://user-images.githubusercontent.com/49353917/210942811-fa5155b1-4c6f-4afc-bea2-d39b4cd594aa.jpg)\r\n\r\n### git clean\r\nUsage: `git-sim clean`\r\n\r\n- Simulated output will show untracked files being deleted\r\n- Since this is just a simulation, no need to specify `-i`, `-n`, `-f` as in regular Git\r\n- Note that simulated output will also show the most recent 5 commits on the active branch\r\n\r\n![git-sim-clean_04-09-23_22-05-54](https://user-images.githubusercontent.com/49353917/230830043-779e7230-f439-461a-a408-b19b263e86e4.jpg)\r\n\r\n### git clone\r\nUsage: `git-sim clone <url>`\r\n\r\n- Clone the remote repo from `<url>` (web URL or filesystem path) to a new folder in the current directory\r\n- Output will report if clone operation is successful and show log of local clone\r\n\r\n![git-sim-clone_04-09-23_21-51-53](https://user-images.githubusercontent.com/49353917/230828521-80c8d2d1-2a31-46bb-aeed-746f0441c86e.jpg)\r\n\r\n### git commit\r\nUsage: `git-sim commit -m \"Commit message\"`\r\n\r\n- Simulated output will show the new commit added to the tip of the active branch\r\n- Specify a commit message with the `-m` option\r\n- HEAD and the active branch will be moved to the new commit\r\n- Simulated output will show files in the staging area being included in the new commit\r\n- Supports amending the last commit with: `$ git-sim commit --amend -m \"Amended commit message\"`\r\n\r\n![git-sim-commit_01-05-23_22-10-21](https://user-images.githubusercontent.com/49353917/210941149-d83677a1-3ab7-4880-bc0f-871b1f150087.jpg)\r\n\r\n### git config\r\nUsage: `git-sim config [--list] <section.option> <value>`\r\n\r\n- Simulated output describes the specified configuration change\r\n- Use `--list` or `-l` to display all configuration\r\n\r\n![git-sim-config_04-16-24_08-34-34](https://github.com/initialcommit-com/git-sim/assets/49353917/c123e7a7-1fff-4f5c-b4a2-1e34ea2a4d80)\r\n\r\n### git fetch\r\nUsage: `git-sim fetch <remote> <branch>`\r\n\r\n- Fetches the specified `<branch>` from the specified `<remote>` to the local repo\r\n\r\n![git-sim-fetch_04-09-23_21-47-59](https://user-images.githubusercontent.com/49353917/230828090-acae8979-4097-43a8-96ea-525890e0e0a8.jpg)\r\n\r\n### git init\r\nUsage: `git-sim init`\r\n\r\n- Simulated output describes the initialized `.git/` directory and it's contents\r\n\r\n![git-sim-init_04-16-24_08-34-47](https://github.com/initialcommit-com/git-sim/assets/49353917/2abb1a4a-3022-4353-a828-2d337baa8383)\r\n\r\n### git log\r\nUsage: `git-sim log [-n <number>] [--all]`\r\n\r\n- Simulated output will show the most recent 5 commits on the active branch by default\r\n- Use `-n <number>` to set number of commits to display from each branch head\r\n- Set `--all` to display all local branches in the log output\r\n\r\n![git-sim-log_01-05-23_22-02-39](https://user-images.githubusercontent.com/49353917/210940300-aadd14c6-72ab-4529-a1be-b494ed5dd4c9.jpg)\r\n\r\n### git merge\r\nUsage: `git-sim merge <branch> [-m \"Commit message\"] [--no-ff]`\r\n\r\n- Specify `<branch>` as the branch name to merge into the active branch\r\n- If desired, specify a commit message with the `-m` option\r\n- Simulated output will depict a fast-forward merge if possible\r\n- Otherwise, a three-way merge will be depicted\r\n- To force a merge commit when a fast-forward is possible, use `--no-ff`\r\n- If merge fails due to merge conflicts, the conflicting files are displayed\r\n\r\n![git-sim-merge_01-05-23_09-44-46](https://user-images.githubusercontent.com/49353917/210942030-c7229488-571a-4943-a1f4-c6e4a0c8ccf3.jpg)\r\n\r\n### git mv\r\nUsage: `git-sim mv <file> <new file>`\r\n\r\n- Specify `<file>` as file to update name/path\r\n- Specify `<new file>` as new name/path of file \r\n- Simulated output will show the name/path of the file being updated \r\n- Note that simulated output will also show the most recent 5 commits on the active branch\r\n\r\n![git-sim-mv_04-09-23_22-05-13](https://user-images.githubusercontent.com/49353917/230829978-0a64dbe2-d974-4cef-9c6e-ed26e987342f.jpg)\r\n\r\n### git pull\r\nUsage: `git-sim pull [<remote> <branch>]`\r\n\r\n- Pulls the specified `<branch>` from the specified `<remote>` to the local repo\r\n- If `<remote>` and `<branch>` are not specified, the active branch is pulled from the default remote\r\n- If merge conflicts occur, they are displayed in a table\r\n\r\n![git-sim-pull_04-09-23_21-50-15](https://user-images.githubusercontent.com/49353917/230828298-455c0a9d-cf94-499e-9e35-623e7b218772.jpg)\r\n\r\n### git push\r\nUsage: `git-sim push [<remote> <branch>]`\r\n\r\n- Pushes the specified `<branch>` to the specified `<remote>` and displays the local result\r\n- If `<remote>` and `<branch>` are not specified, the active branch is pushed to the default remote\r\n- If the push fails due to remote changes that don't exist in the local repo, a message is included telling the user to pull first, along with color coding which commits need to be pulled\r\n\r\n![git-sim-push_04-21-23_13-41-57](https://user-images.githubusercontent.com/49353917/233731005-51fd7887-ae14-4ceb-a5d5-e5aed79e9fd8.jpg)\r\n\r\n### git rebase\r\nUsage: `git-sim rebase <new-base>`\r\n\r\n- Specify `<new-base>` as the branch name to rebase the active branch onto\r\n\r\n![git-sim-rebase_01-05-23_09-53-34](https://user-images.githubusercontent.com/49353917/210942598-4ff8d1e6-464d-48f3-afb9-f46f7ec4828c.jpg)\r\n\r\n### git remote\r\nUsage: `git-sim remote [add|rename|remove|get-url|set-url] [<remote>] [<url>]`\r\n\r\n- Simulated output will show remotes being added, renamed, removed, modified as indicated\r\n- Running `git-sim remote` with no options will list all existing remotes and their details  \r\n\r\n![git-sim-remote_04-16-24_08-40-37](https://github.com/initialcommit-com/git-sim/assets/49353917/ebaff04c-d5b6-4691-97b3-60bb502ba444)\r\n\r\n### git reset\r\nUsage: `git-sim reset <reset-to> [--mixed|--soft|--hard]`\r\n\r\n- Specify `<reset-to>` as any commit id, branch name, tag, or other ref to simulate reset to from the current HEAD (default: `HEAD`)\r\n- As with a normal git reset command, default reset mode is `--mixed`, but can be specified using `--soft`, `--hard`, or `--mixed`\r\n- Simulated output will show branch/HEAD resets and resulting state of the working directory, staging area, and whether any file changes would be deleted by running the actual command\r\n\r\n![git-sim-reset_01-05-23_22-15-49](https://user-images.githubusercontent.com/49353917/210941835-80f032d2-4f06-4032-8dd0-98c8a2569049.jpg)\r\n\r\n### git restore\r\nUsage: `git-sim restore <file 1> <file 2> ... <file n>`\r\n\r\n- Specify one or more `<file>` as a *modified* working directory file, or staged file\r\n- Simulated output will show files being moved back to the working directory or discarded changes\r\n- Note that simulated output will also show the most recent 5 commits on the active branch\r\n\r\n![git-sim-restore_01-05-23_22-09-14](https://user-images.githubusercontent.com/49353917/210941009-e6bf7271-ce9b-4e41-9a0b-24cc4b8d3b15.jpg)\r\n\r\n### git revert\r\nUsage: `git-sim revert <to-revert>`\r\n\r\n- Specify `<to-revert>` as any commit id, branch name, tag, or other ref to simulate revert for\r\n- Simulated output will show the new commit which reverts the changes from `<to-revert>`\r\n- Simulated output will include the next 4 most recent commits on the active branch\r\n\r\n![git-sim-revert_01-05-23_22-16-59](https://user-images.githubusercontent.com/49353917/210941979-6db8b55c-2881-41d8-9e2e-6263b1dece13.jpg)\r\n\r\n### git rm\r\nUsage: `git-sim rm <file 1> <file 2> ... <file n>`\r\n\r\n- Specify one or more `<file>` as a *tracked* file\r\n- Simulated output will show files being removed from Git tracking\r\n- Note that simulated output will also show the most recent 5 commits on the active branch\r\n\r\n![git-sim-rm_04-09-23_22-01-29](https://user-images.githubusercontent.com/49353917/230829899-f5d688ea-bc8e-46f9-a54a-55d251c8915d.jpg)\r\n\r\n### git stash\r\nUsage: `git-sim stash [push|pop|apply] <file>`\r\n\r\n- Specify one or more `<file>` as a *modified* working directory file, or staged file\r\n- If no `<file>` is specified, all available files will be included\r\n- Simulated output will show files being moved in/out of the Git stash\r\n- Note that simulated output will also show the most recent 5 commits on the active branch\r\n\r\n![git-sim-stash_01-05-23_22-11-18](https://user-images.githubusercontent.com/49353917/210941254-69c80b63-5c06-411a-a36a-1454b2906ee8.jpg)\r\n\r\n### git status\r\nUsage: `git-sim status`\r\n\r\n- Simulated output will show the state of the working directory, staging area, and untracked files\r\n- Note that simulated output will also show the most recent 5 commits on the active branch\r\n\r\n![git-sim-status_01-05-23_22-06-28](https://user-images.githubusercontent.com/49353917/210940685-735665e2-fa12-4043-979c-54c295b13800.jpg)\r\n\r\n### git switch\r\nUsage: `git-sim switch [-c] <branch>`\r\n\r\n- Switches the checked-out branch to `<branch>`, i.e. moves `HEAD` to the specified `<branch>`\r\n- The `-c` flag creates a new branch with the specified name `<branch>` and switches to it, assuming it doesn't already exist\r\n\r\n![git-sim-switch_04-09-23_21-42-43](https://user-images.githubusercontent.com/49353917/230827783-a8740ace-b66f-4cac-b94e-5d101d27e0b5.jpg)\r\n\r\n### git tag\r\nUsage: `git-sim tag <new tag name>`\r\n\r\n- Specify `<new tag name>` as the name of the new tag to simulate creation of\r\n- Simulated output will show the newly create tag ref along with most recent 5 commits on the active branch\r\n\r\n![git-sim-tag_01-05-23_22-14-18](https://user-images.githubusercontent.com/49353917/210941647-79376ff7-2941-42b3-964a-b1d3a404a4fe.jpg)\r\n\r\n## Video animation examples\r\n```console\r\n$ git-sim --animate reset HEAD^\r\n```\r\n\r\nhttps://user-images.githubusercontent.com/49353917/210943230-f38d879b-bb0d-4d42-a196-f24efb9e351a.mp4\r\n\r\n```console\r\n$ git checkout main\r\n$ git-sim --animate merge dev\r\n```\r\n\r\nhttps://user-images.githubusercontent.com/49353917/210943418-22c2cd11-be96-41bc-b621-7018eebc6bc0.mp4\r\n\r\n```console\r\n$ git checkout dev\r\n$ git-sim --animate rebase main\r\n```\r\n\r\nhttps://user-images.githubusercontent.com/49353917/210943815-4b8be2da-18da-4c42-927a-61cf9a22834e.mp4\r\n\r\n```console\r\n$ git checkout main\r\n$ git-sim --animate cherry-pick dev\r\n```\r\n\r\nhttps://user-images.githubusercontent.com/49353917/210944001-77bd0130-306b-40a8-ba0b-22e50172802b.mp4\r\n\r\n## Basic command examples\r\nSimulate the output of the git log command:\r\n\r\n```console\r\n$ cd path/to/git/repo\r\n$ git-sim log\r\n```\r\n\r\nSimulate the output of the git status command:\r\n\r\n```console\r\n$ git-sim status\r\n```\r\n\r\nSimulate adding a file to the Git staging area:\r\n\r\n```console\r\n$ git-sim add filename.ext\r\n```\r\n\r\nSimulate restoring a file from the Git staging area:\r\n\r\n```console\r\n$ git-sim restore filename.ext\r\n```\r\n\r\nSimulate creating a new commit based on currently staged changes:\r\n\r\n```console\r\n$ git-sim commit -m \"Commit message\"\r\n```\r\n\r\nSimulate stashing all working directory and staged changes:\r\n\r\n```console\r\n$ git-sim stash\r\n```\r\n\r\nSimulate creating a new Git branch:\r\n\r\n```console\r\n$ git-sim branch new-branch-name\r\n```\r\n\r\nSimulate creating a new Git tag:\r\n\r\n```console\r\n$ git-sim tag new-tag-name\r\n```\r\n\r\nSimulate a hard reset of the current branch HEAD to the previous commit:\r\n\r\n```console\r\n$ git-sim reset HEAD^ --hard\r\n```\r\n\r\nSimulate reverting the changes in an older commit:\r\n\r\n```console\r\n$ git-sim revert HEAD~7\r\n```\r\n\r\nSimulate merging a branch into the active branch:\r\n\r\n```console\r\n$ git-sim merge feature1\r\n```\r\n\r\nSimulate rebasing the active branch onto a new base:\r\n\r\n```console\r\n$ git-sim rebase main\r\n```\r\n\r\nSimulate cherry-picking a commit from another branch onto the active branch:\r\n\r\n```console\r\n$ git-sim cherry-pick 0ae641\r\n```\r\n\r\n## Command examples with extra options/flags\r\nUse light mode for white background and black text, instead of the default black background with white text:\r\n\r\n```console\r\n$ git-sim --light-mode status\r\n```\r\n\r\nAnimate the simulated output as a .mp4 video file:\r\n\r\n```console\r\n$ git-sim --animate add filename.ext\r\n```\r\n\r\nAdd an intro and outro with custom text and logo (must include `--animate`):\r\n\r\n```console\r\n$ git-sim --animate --show-intro --show-outro --outro-top-text=\"My Git Repo\" --outro-bottom-text=\"Thanks for watching!\" --logo=path/to/logo.png status\r\n```\r\n\r\nCustomize the output image/video directory location:\r\n\r\n```console\r\n$ git-sim --media-dir=path/to/output status\r\n```\r\n\r\nOptionally, set the environment variable `git_sim_media_dir` to set a global default media directory, to be used if no `--media-dir` is provided. Simulated output images/videos will be placed in this location, in subfolders named with the corresponding repo's name.\r\n\r\n```console\r\n$ export git_sim_media_dir=path/to/media/directory\r\n$ git-sim status\r\n```\r\nNote: `--media-dir` takes precedence over the environment variable. If you set the environment variable and still provide the argument, you'll find the media in the path provided by `--media-dir`.\r\n\r\nGenerate output video in low quality to speed up rendering time (useful for repeated testing, must include `--animate`):\r\n\r\n```console\r\n$ git-sim --animate --low-quality status\r\n```\r\n\r\n## Installation\r\nSee **Quickstart** section for details on installing manim and other dependencies. Then run:\r\n\r\n```console\r\n$ pip3 install git-sim\r\n```\r\n\r\n## Docker installation\r\n\r\n1) Clone down the git-sim repository:\r\n\r\n```console\r\n$ git clone https://github.com/initialcommit-com/git-sim.git\r\n```\r\n\r\n2) Browse into the `git-sim` folder and build the Docker image:\r\n\r\n```console\r\n$ docker build -t git-sim .\r\n```\r\n\r\n3) Run git-sim commands as follows:\r\n    - Windows: `docker run --rm -v %cd%:/usr/src/git-sim git-sim [global options] <subcommand> [subcommand options]`\r\n    - MacOS / Linux: `docker run --rm -v $(pwd):/usr/src/git-sim git-sim [global options] <subcommand> [subcommand options]`\r\n    \r\nOptional: On MacOS / Linux / or GitBash in Windows, create an alias for the long docker command so your can run it as a normal `git-sim` command. To do so add the following line to your `.bashrc` or equivalent, then restart your terminal:\r\n\r\n```bash\r\ngit-sim() { docker run --rm -v $(pwd):/usr/src/git-sim git-sim \"$@\"; }\r\n```\r\n\r\nThis will enable you to run git-sim subcommands as [described above](#commands).\r\n\r\n## Learn More\r\nLearn more about this tool on the [git-sim project page](https://initialcommit.com/tools/git-sim).\r\n\r\n## Authors\r\n**Jacob Stopak** - on behalf of [Initial Commit](https://initialcommit.com)\r\n",
    "bugtrack_url": null,
    "license": "GPL-2.0",
    "summary": "Simulate Git commands on your own repos by generating an image (default) or video visualization depicting the command's behavior.",
    "version": "0.3.4",
    "project_urls": {
        "Homepage": "https://initialcommit.com/tools/git-sim",
        "Source": "https://github.com/initialcommit-com/git-sim"
    },
    "split_keywords": [
        "git",
        " sim",
        " simulation",
        " simulate",
        " git-simulate",
        " git-simulation",
        " git-sim",
        " manim",
        " animation",
        " gitanimation",
        " image",
        " video",
        " dryrun",
        " dry-run"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ee8b28712d59bfacb857da2cf7fabce5e23093245f6153d9f553d5f2e4a19f29",
                "md5": "7ccfc343f4269404d0a2bec800f3ddc2",
                "sha256": "32813b6b0509adc5301481096c333e2de3e3b0da0c81d5f2e47f03823829ba64"
            },
            "downloads": -1,
            "filename": "git_sim-0.3.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7ccfc343f4269404d0a2bec800f3ddc2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 67658,
            "upload_time": "2024-04-16T17:33:14",
            "upload_time_iso_8601": "2024-04-16T17:33:14.039469Z",
            "url": "https://files.pythonhosted.org/packages/ee/8b/28712d59bfacb857da2cf7fabce5e23093245f6153d9f553d5f2e4a19f29/git_sim-0.3.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e6405ccfbd10130b460087b771808b70ad48536a6b5cfa0094bcef6d1af74492",
                "md5": "1f4f155ad372693eff1d02ef708ac310",
                "sha256": "9ad528e585eada916696d2a0eb46345c2656d68f7d405bd8e080abcd336c2282"
            },
            "downloads": -1,
            "filename": "git_sim-0.3.4.tar.gz",
            "has_sig": false,
            "md5_digest": "1f4f155ad372693eff1d02ef708ac310",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 58162,
            "upload_time": "2024-04-16T17:33:18",
            "upload_time_iso_8601": "2024-04-16T17:33:18.560741Z",
            "url": "https://files.pythonhosted.org/packages/e6/40/5ccfbd10130b460087b771808b70ad48536a6b5cfa0094bcef6d1af74492/git_sim-0.3.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-16 17:33:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "initialcommit-com",
    "github_project": "git-sim",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "git-sim"
}
        
Elapsed time: 3.82194s