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 2000e45
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+15-12Lines changed: 15 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -228,14 +228,15 @@ To set up both in every agent on your machine, run:
228
228
229
229
```console
230
230
$ git-sim wire-agents
231
+
$ git-sim unwire-agents
231
232
```
232
233
233
234
Then restart any agents that are running. Wire-agents sets up both the hook and MCP server in Claude Code, Codex CLI, Cursor, GitHub Copilot CLI, Gemini CLI, and VS Code (Copilot), and the MCP server only in Windsurf, Cline, Roo Code, Amazon Q Developer CLI, and Claude Desktop, which have no hooks.
234
235
235
-
Designate specific agents with: `--agent claude --agent cursor`
236
-
Skip hook or mcp as desired: `--no-hook` or `--no-mcp`
237
-
Dry run with: `--dry-run`
238
-
Remove hook and mcp configuration with: `git-sim unwire-agents`
236
+
-Designate specific agents with: `--agent claude --agent cursor`
237
+
-Skip hook or mcp as desired: `--no-hook` or `--no-mcp`
238
+
-Dry run with: `--dry-run`
239
+
-Remove hook and mcp configuration with: `git-sim unwire-agents`
239
240
240
241
Here's an example of what Claude Code prompt looks like if it tries to run a hard Git reset:
241
242
@@ -863,25 +864,27 @@ Animation-only global options (to be used in conjunction with `--animate`):
863
864
864
865
## Installation
865
866
866
-
git-sim ships in tiers, so an AI agent's machine or a CI runner installs only what it needs:
867
+
For convenience, git-sim ships in 3 tiers. **Core** is the default and the right choice for the vast majority of users:
867
868
868
869
| Tier | Install | Includes |
869
870
|---|---|---|
870
-
|**core** (default) |`pip install git-sim`|pre-flight engine, text commit graph, static image simulation (skia), MCP server (`git-sim-mcp`), Claude Code hook (`git-sim-hook`) |
871
+
|**core** (default) |`pip install git-sim`|git command simulation, pre-flight engine, MCP server (`git-sim-mcp`), Claude Code hook (`git-sim-hook`) |
871
872
|**extras**|`pip install "git-sim[extras]"`| everything in core, plus animated video output (`--animate`) via Manim (install Manim's own system dependencies first, see below) |
872
873
|**min**| see below | pre-flight engine, text commit graph and MCP server only, with no image rendering, for headless machines |
873
874
875
+
For **extras** tier:
876
+
877
+
Animated video (`--animate`) uses Manim, which needs FFmpeg and other system packages: install them first with the Manim guide for [Windows](https://docs.manim.community/en/stable/installation/windows.html), [macOS](https://docs.manim.community/en/stable/installation/macos.html), [Linux](https://docs.manim.community/en/stable/installation/linux.html), or [Conda](https://docs.manim.community/en/stable/installation/conda.html). On macOS, it is recommended to use a Homebrew Python or a virtual environment rather than the system Python.
878
+
879
+
For **min** tier:
880
+
874
881
pip extras can only add packages, so the `min` tier is the core package installed without its rendering dependencies (`skia-python`, `numpy`):
Older docs mention `pip install git-sim[mcp]`, which still works and is the same as core.
882
-
883
-
Animated video (`--animate`) uses Manim, which needs FFmpeg and other system packages: install them first with the Manim guide for [Windows](https://docs.manim.community/en/stable/installation/windows.html), [macOS](https://docs.manim.community/en/stable/installation/macos.html), [Linux](https://docs.manim.community/en/stable/installation/linux.html), or [Conda](https://docs.manim.community/en/stable/installation/conda.html). On macOS, use a Homebrew Python or a virtual environment rather than the system Python.
884
-
885
888
### Docker
886
889
887
890
<details>
@@ -909,7 +912,7 @@ Optional: On MacOS / Linux / or GitBash in Windows, create an alias for the long
909
912
git-sim() { docker run --rm -v $(pwd):/usr/src/git-sim git-sim "$@"; }
910
913
```
911
914
912
-
This will enable you to run git-sim subcommands as [described above](https://github.com/initialcommit-com/git-sim#supported-git-commands).
915
+
This will enable you to run [all the git-sim subcommands described above](https://github.com/initialcommit-com/git-sim#supported-git-commands).
913
916
914
917
</details>
915
918
@@ -957,7 +960,7 @@ To change how it runs, add a `with:` block under the `uses:` line:
957
960
| `python-version` | `3.12` | The Python that git-sim is installed with |
958
961
| `token` | the workflow's own token | The token used to post the comment, to post as another account or bot |
959
962
960
-
Pull requests from forks get a read-only token, which can't post comments, so set `comment: "false"` if your repo takes them. The graph is still attached to the run.
963
+
Pull requests from forks get a read-only token, which can't post comments, so set `comment: "false"`. The graph artifact will still attach to the run.
0 commit comments