Skip to content

Commit 0c8133f

Browse files
Refine README instructions for git-sim usage
Updated descriptions for clarity and consistency in README.
1 parent d17e67b commit 0c8133f

1 file changed

Lines changed: 10 additions & 17 deletions

File tree

‎README.md‎

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ $ pip install git-sim
8080

8181
Or `pipx install git-sim`, or `uv tool install git-sim`.
8282

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`
8484

8585
```console
8686
$ git-sim merge dev
@@ -92,7 +92,7 @@ By default, git-sim creates a web-first, shareable visualization that opens in y
9292

9393
Run `git-sim -h` to list all commands.
9494

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
9696

9797
```console
9898
$ git-sim live
@@ -106,14 +106,21 @@ $ code --install-extension initialcommit.git-sim
106106

107107
Or search for **git-sim** in the Extensions view (the Marketplace in VS Code, Open VSX in Cursor, Windsurf, and VSCodium).
108108

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:
110110

111111
```
112112
%load_ext git_sim.jupyter
113113
%gitsim rebase main
114114
%gitsim live
115+
%gitsim live stop
115116
```
116117

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+
117124
**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).
118125

119126
**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
906913

907914
</details>
908915

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).
922-
923916
### GitHub
924917

925918
<details>

0 commit comments

Comments
 (0)