Skip to content

Latest commit

 

History

History
115 lines (89 loc) · 2.52 KB

USER_GUIDE.md

File metadata and controls

115 lines (89 loc) · 2.52 KB
Raw

Cloe User Guide

User guide covers the commands in Cloe v2.0.0+.

This guide assumes that you have set up an alias for Cloe. If you have not set up an alias for Cloe, just replace cloe with python3 path/to/cloe.py in the following commands.

Requirements

  • Python 3.5+
  • Zoom Desktop Client installed on your system
  • Additionally, staying logged in on the Zoom Desktop Client will help avoid any unexpected errors
     

Commands

Cloe performs 5 actions:

add, join, list, remove, reset

1. Save a new meeting for Cloe to remember

  • Save a new Zoom meeting that does not require a password:

    $ cloe add <meeting-name> <meeting-id>

  • Save a new Zoom meeting that requires a password:

    $ cloe add <meeting-name> <meeting-id> <meeting-password>

Note: Meeting names should not contain whitespaces.

2. Join a meeting

Quick join a meeting

  • Quick join a meeting without a password:

    $ cloe join -q <meeting-id>

  • Quick join a meeting with a password:

    $ cloe join -q <meeting-id> <meeting-password>

Join a saved meeting

  • Join a saved meeting using the meeting name:

    $ cloe join <meeting-name>

  • Join a saved meeting using the meeting index:

    $ cloe join <meeting-index>

Usage:

$ cloe join -q 123-4567-8901 

$ cloe join -q 12345678901 pw1234

$ cloe join my-meeting 

$ cloe join 4

Note: The meeting ID is allowed to contain hyphens - ; Cloe will remove hyphens before performing any operation.

Note: The meeting index can be found by listing the saved meeting.

3. List saved meetings

  • List the names of all the saved meetings:

    $ cloe list

  • List the names and IDs of all the saved meetings:

    $ cloe list -i

  • List the names, IDs, and passwords of all the saved meetings:

    $ cloe list -p

4. Remove a saved meeting

$ cloe remove <meeting-name>

Meetings can only be removed by name.

5. Clear all saved meetings

This removes all saved meetings from Cloe.

$ cloe reset

Cloe will prompt the user for confirmation before clearing the saved meetings.