CLI reference#

Full reference for the inspect-jitsi command - every subcommand, argument, and option - generated from its own --help output. See Check a Jitsi conference from the command line for a task-oriented walkthrough instead.

Requires the cli extra - see Installation.

inspect-jitsi#

Tools for inspecting a running Jitsi Meet deployment.

Documentation: https://inspect-jitsi.readthedocs.io/en/latest/

Source code: niccokunzmann/inspect-jitsi

Usage:

$ inspect-jitsi [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • count: Print the number of participants currently…

  • participants: Print the participants currently in a…

  • diagnose: Print connectivity/auth diagnostics for a…

  • created: Exit 0 if the room exists, 1 if not.

  • monitor: Follow a room until it is closed, printing…

inspect-jitsi count#

Print the number of participants currently in a Jitsi Meet room.

Usage:

$ inspect-jitsi count [OPTIONS] {conference_url}

Arguments:

  • conference_url: [required]

Options:

  • --name <str>: Display name to disclose when joining the room. [env var: INSPECT_JITSI_NAME; default: inspect-jitsi]

  • --help: Show this message and exit.

inspect-jitsi participants#

Print the participants currently in a Jitsi Meet room, as indented JSON.

Usage:

$ inspect-jitsi participants [OPTIONS] {conference_url}

Arguments:

  • conference_url: [required]

Options:

  • --name <str>: Display name to disclose when joining the room. [env var: INSPECT_JITSI_NAME; default: inspect-jitsi]

  • --help: Show this message and exit.

inspect-jitsi diagnose#

Print connectivity/auth diagnostics for a Jitsi deployment.

Usage:

$ inspect-jitsi diagnose [OPTIONS] {conference_url}

Arguments:

  • conference_url: [required]

Options:

  • --help: Show this message and exit.

inspect-jitsi created#

Exit 0 if the room exists, 1 if not. Prints nothing unless –json is given.

Usage:

$ inspect-jitsi created [OPTIONS] {conference_url}

Arguments:

  • conference_url: [required]

Options:

  • --json: Print true/false as JSON, in addition to the exit code.

  • --help: Show this message and exit.

inspect-jitsi monitor#

Follow a room until it is closed, printing a JSON line on every change.

Documentation: https://inspect-jitsi.readthedocs.io/en/latest/how-to/monitor-a-conference.html

Usage:

$ inspect-jitsi monitor [OPTIONS] {conference_url}

Arguments:

  • conference_url: [required]

Options:

  • --name <str>: Display name to disclose when joining the room. [env var: INSPECT_JITSI_NAME; default: inspect-jitsi]

  • --create: Join the room even if it does not exist, which creates it if the server allows that. By default a missing room is reported as closed without joining it.

  • --stay: Stay in the room and keep it open when nobody else is in it. By default the monitor leaves and reports the room as closed.

  • --timeout <float range>: Seconds to keep trying to reconnect after the connection is lost. 0 disables reconnecting. [env var: INSPECT_JITSI_TIMEOUT; default: 60; x>=0]

  • --help: Show this message and exit.