Metadata-Version: 2.1
Name: bbbctl
Version: 0.0.1
Summary: BigBlueButton API command-line client
Home-page: https://github.com/defnull/bbbctl
Author: Marcel Hellkamp
Author-email: marc@gsites.de
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/defnull/bbbctl/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# Command-line tools for the BBB REST API

## Usage

```sh
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


