Skip to content

Commit 2000e45

Browse files
Revise README for clarity and installation details
Updated installation instructions and clarified agent designation options in README.
1 parent 5369366 commit 2000e45

1 file changed

Lines changed: 15 additions & 12 deletions

File tree

‎README.md‎

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -228,14 +228,15 @@ To set up both in every agent on your machine, run:
228228

229229
```console
230230
$ git-sim wire-agents
231+
$ git-sim unwire-agents
231232
```
232233

233234
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.
234235

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

240241
Here's an example of what Claude Code prompt looks like if it tries to run a hard Git reset:
241242

@@ -863,25 +864,27 @@ Animation-only global options (to be used in conjunction with `--animate`):
863864

864865
## Installation
865866

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

868869
| Tier | Install | Includes |
869870
|---|---|---|
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`) |
871872
| **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) |
872873
| **min** | see below | pre-flight engine, text commit graph and MCP server only, with no image rendering, for headless machines |
873874

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+
874881
pip extras can only add packages, so the `min` tier is the core package installed without its rendering dependencies (`skia-python`, `numpy`):
875882

876883
```console
877884
$ pip install --no-deps git-sim
878885
$ pip install gitpython "mcp>=2.0" typer pydantic-settings fonttools git-dummy
879886
```
880887

881-
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-
885888
### Docker
886889

887890
<details>
@@ -909,7 +912,7 @@ Optional: On MacOS / Linux / or GitBash in Windows, create an alias for the long
909912
git-sim() { docker run --rm -v $(pwd):/usr/src/git-sim git-sim "$@"; }
910913
```
911914

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).
913916

914917
</details>
915918

@@ -957,7 +960,7 @@ To change how it runs, add a `with:` block under the `uses:` line:
957960
| `python-version` | `3.12` | The Python that git-sim is installed with |
958961
| `token` | the workflow's own token | The token used to post the comment, to post as another account or bot |
959962

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.
961964
962965
</details>
963966

0 commit comments

Comments
 (0)