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 3a73eac
Browse filesBrowse the repository at this point in the historyBrowse files
The magic runs git-sim live in the background and frames the page its
local server serves, so the graph updates under the cell as the repo
changes. %gitsim live stop stops it, as does restarting the kernel, and
running it again reuses the server. A hosted notebook (Colab,
JupyterHub, Binder) gets a note instead, since its browser can't reach
the kernel's 127.0.0.1.
The live server refuses to be framed, so a hidden --allow-local-frames
option lets the magic's server be framed by localhost pages only. A
plain git-sim live still sends X-Frame-Options: DENY.
Signed-off-by: Jacob Stopak <jacob@initialcommit.io>
Copy file name to clipboardExpand all lines: docs/integrations.md
+7-1Lines changed: 7 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ git-sim works anywhere you use Git. The `git-sim` command line tool does the wor
11
11
| Vim 8.1 and newer | the same commands as Neovim |[integrations/vim](../integrations/vim)|
12
12
| Emacs 27.1 and newer |`git-sim-simulate`, `git-sim-preflight`, and `git-sim-live`, with Magit's branch or commit at point as the default |[integrations/emacs](../integrations/emacs)|
13
13
| nano, and editors without plugins |`git live` in a second terminal pane, and nano's execute prompt (`^T`) to drop a pre-flight report into your file |[shell.md](shell.md)|
14
-
| Jupyter |`%gitsim rebase main` shows the graph right under the cell | below |
14
+
| Jupyter |`%gitsim rebase main` shows the graph right under the cell, and `%gitsim live` shows the live graph there| below |
15
15
| GitHub CLI |`gh sim pr 42` shows what merging a pull request would do |[integrations/gh-sim](../integrations/gh-sim)|
16
16
| GitHub Actions | a comment on each pull request with the pre-flight report, and the graph attached to the run |[integrations/github-action](../integrations/github-action)|
17
17
| Blogs and docs |`git-sim-embed.js` wraps any git-sim graph in the interactive viewer |[embed.md](embed.md)|
The command runs in the notebook's working directory (or the `-C` path), the same as it would in a terminal. The graph shows up in a frame under the cell that grows to fit it, up to 1200 pixels. To pick the height yourself, put `--height` and a number of pixels before the Git command. `preflight` prints the report as text. git-sim never changes your repo.
42
+
43
+
`%gitsim live` runs `git-sim live` in the background and shows the live page under the cell, 760 pixels tall unless you set `--height`. It updates as the repo changes, whether you run Git in the notebook or in a terminal, and you can add live mode options after it, like `%gitsim live --no-zones`. Running it again shows the same session. `%gitsim live stop` stops it, and so does restarting the kernel.
44
+
45
+
Live mode only works when Jupyter runs on your own machine, because the page comes from a small server on the kernel's `127.0.0.1`. In Colab, JupyterHub, or Binder, run `git-sim live` on the machine with the repo instead.
0 commit comments