Skip to main content

BigBlueButton API command-line client

Project description

Command-line tools for the BBB REST API

Usage

export BBBCTL_SERVER=https://meet.gwdg.de/
export BBBCTL_SECRET=...
./bbbctl.py -h              # print help
./bbbctl.py meeting list    # list meetings
./bbbctl.py record list     # list recordings
...

Output format

The default output format is currently a human readable plain text format. You can switch to a more compact version with --compact. Other formats (e.g. json, yaml or xml) may be supported in the future.

Command overview

You can get detailed help with ./bbbctl.py -h or ./bbbctl.py <command> -h.

  • record Work with recordings
    • list List all recordings
    • info <recordID> Show info about a recording
    • publishs <recordID> Publish an unpublished recording
    • unpublish <recordID> Unpublish (hide) recording)
    • delete <recordID> Delete a recording
  • meeting List, inspect or end meetings
    • list List all meetings
    • info <meetingID> Show info about a meeting
    • create <meetingID> <name> Create a meeting and optionally print a bunch of join links
    • join <meetingID> <name> Generate a join link for a running meeting
    • end <meetingID> Forcefully end a meeting
    • nuke Forcefully end ALL meetings

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bbbctl-0.0.1.tar.gz (5.3 kB view hashes)

Uploaded Source

Built Distribution

bbbctl-0.0.1-py3-none-any.whl (5.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page