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
{{ message }}
Repository navigation
Commit 0c8133f
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+10-17Lines changed: 10 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -80,7 +80,7 @@ $ pip install git-sim
80
80
81
81
Or `pipx install git-sim`, or `uv tool install git-sim`.
82
82
83
-
**2. Simulate a command:** in a local Git repo, prefix any Git command with `git-sim` instead of `git`
83
+
**2. Simulate any Git command:** in your local repo, prefix any Git command with `git-sim` instead of `git`
84
84
85
85
```console
86
86
$ git-sim merge dev
@@ -92,7 +92,7 @@ By default, git-sim creates a web-first, shareable visualization that opens in y
92
92
93
93
Run `git-sim -h` to list all commands.
94
94
95
-
**3. Watch your repo live:** a graph that follows your repo as it changes, and records every command you (or your agents) run
95
+
**3. Watch your repo update in real time:** a live graph that animates each Git operation in sequence, recording it so you can save, replay, and share it
Or search for **git-sim** in the Extensions view (the Marketplace in VS Code, Open VSX in Cursor, Windsurf, and VSCodium).
108
108
109
-
**5. Jupyter integration:**with git-sim installed in the notebook's environment, the graph shows up right under the cell
109
+
**5. Jupyter Notebook integration:**after installing git-sim in the notebook's Python environment:
110
110
111
111
```
112
112
%load_ext git_sim.jupyter
113
113
%gitsim rebase main
114
114
%gitsim live
115
+
%gitsim live stop
115
116
```
116
117
118
+
From Jupyter, git-sim simulates Git commands against the repo in the notebook's working directory, or path specified after the `-C` flag.
119
+
120
+
The graph's frame grows to fit it unless you set `--height` in pixels.
121
+
122
+
`%gitsim live` runs live mode in the background until you stop it or restart the kernel, and needs Jupyter running on your own machine (not Colab, JupyterHub, or Binder).
123
+
117
124
**6. Pull request integration:**`gh sim pr 42` simulates merging a pull request, and the git-sim GitHub Action comments the pre-flight report on each one. See [Installation](https://github.com/initialcommit-com/git-sim#github).
118
125
119
126
**7. Check a risky command before it runs:** how risky it is, and what you could lose
@@ -906,20 +913,6 @@ This will enable you to run git-sim subcommands as [described above](https://git
906
913
907
914
</details>
908
915
909
-
### Jupyter
910
-
911
-
Install git-sim in the same environment as the notebook's kernel (`pip install git-sim`), then in a notebook:
912
-
913
-
```
914
-
%load_ext git_sim.jupyter
915
-
%gitsim rebase main
916
-
%gitsim preflight reset --hard HEAD~1
917
-
%gitsim live
918
-
%gitsim live stop
919
-
```
920
-
921
-
Commands run in the notebook's working directory, or the `-C` path. The graph's frame grows to fit it unless you set `--height`. `%gitsim live` runs live mode in the background until you stop it or restart the kernel, and needs Jupyter running on your own machine (not Colab, JupyterHub, or Binder).
0 commit comments