hg-nbdiffweb - Man Page

A mercurial web-based differ for notebooks

Description

usage: hg-nbdiffweb [-h] [--version] [--config]

[--log-level {DEBUG,INFO,WARN,ERROR,CRITICAL}] [-p PORT]

[-b BROWSER] [--persist] [--ip IP] [-w WORKDIRECTORY] [--base-url BASE_URL] [--show-unchanged] [--identical-lines-margin IDENTICAL_LINES_MARGIN] [-s] [-o] [-a] [-m] [-i] [-d] local remote

A mercurial external differ for notebooks.

Uses nbdime to create diffs for notebooks instead of plain text diffs of JSON. See the documentation for how to correctly configure mercurial to use this.

Use with:

hg extdiff -p hg-nbdiff [<commit> [<commit>]]

positional arguments

local

The local modified notebook filename.

remote

The remote modified notebook filename.

options

-h, --help

show this help message and exit

--version

show program's version number and exit

--config

list the valid config keys and their current effective values

--log-level {DEBUG,INFO,WARN,ERROR,CRITICAL}

set the log level by name.

-p, --port PORT

specify the port you want the server to run on. Default is 0 (random).

-b, --browser BROWSER

specify the browser to use, to override the system default.

--persist

prevent server shutting down on remote close request (when these would normally be supported).

--ip IP

specify the interface to listen to for the web server. NOTE: Setting this to anything other than 127.0.0.1/localhost might comprimise the security of your computer. Use with care!

-w, --workdirectory WORKDIRECTORY

specify the working directory you want the server to run from. Default is the actual cwd at program start.

--base-url BASE_URL

The base URL prefix under which to run the web app

--show-unchanged

show unchanged cells by default

--identical-lines-margin IDENTICAL_LINES_MARGIN

Margin for collapsing identical lines in editor; set to -1 to deactivate.

ignorables

Set which parts of the notebook (not) to process.

-s,  --sources,  -S,  --ignore-sources

process/ignore sources.

-o,  --outputs,  -O,  --ignore-outputs

process/ignore outputs.

-a,  --attachments,  -A,  --ignore-attachments

process/ignore attachments.

-m,  --metadata,  -M,  --ignore-metadata

process/ignore metadata.

-i,  --id,  -I,  --ignore-id

process/ignore identifiers.

-d,  --details,  -D,  --ignore-details

process/ignore details not covered by other options.

Info

July 2024 hg-nbdiffweb 4.0.1