Skip to content

Document executing commands from the dev tools console #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 23, 2025
Merged

Document executing commands from the dev tools console #24

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8cf2448
Document executing commands from the dev tools console
jtpio Oct 23, 2025
2e9e821
lint
jtpio Oct 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,26 @@ app.commands.execute('jupyterlab-diff:unified-file-diff', {
});
```

### Browser console via `window.jupyterapp`

The commands can also be run from the browser console (for example during development) via the `app` object exposed as `window.jupyterapp`. The commands can be executed exactly the same way using `window.jupyterapp.commands.execute(...)`.

First JupyterLab needs to be started with the `--expose-app-in-browser` flag to expose `window.jupyterapp`:

```
jupyter lab --expose-app-in-browser
```

Then, in the browser dev tools console:

```javascript
window.jupyterapp.commands.execute('jupyterlab-diff:split-cell-diff', {
originalSource: `def add():\n return\n`,
newSource: `def add(a, b):\n return a + b\n`,
showActionButtons: true
});
```

### Command Arguments

#### `jupyterlab-diff:split-cell-diff` (Split View)
Expand Down
Loading