Skip to content

README.md

Latest commit

 

History

History
141 lines (95 loc) · 3.83 KB

README.md

File metadata and controls

141 lines (95 loc) · 3.83 KB

Webex Terminal

This was an experimental project to gain experience using JetBrains Junie. Every single line of code and documentation (except this very introduction) was written using Junie, and I will attempt to maintain it using Junie.

A terminal client for Cisco Webex that allows you to join and interact with Webex rooms directly from your terminal.

Features

  • OAuth2 authentication with token storage for multiple sessions
  • Join Webex rooms from the terminal
  • One room per terminal (joining a new room stops listening to the previous one)
  • Real-time message updates using websockets

Installation

From PyPI

pip install webex-terminal

From Source

git clone https://github.com/yourusername/webex-terminal.git
cd webex-terminal
pip install -e .

Usage

Start the application by running:

webex-terminal

This will start the application directly. If you're not authenticated, you'll see a welcome message and instructions to use the /auth command to authenticate.

Authentication

To authenticate with Webex, use the /auth command within the application:

/auth

This will open a browser window for OAuth2 authentication. After successful authentication, the token will be stored locally for future sessions.

Listing Rooms

To list available rooms, use the /rooms command within the application:

/rooms

To filter rooms by title:

/rooms filter text

This will only display rooms with titles containing the specified filter text.

Joining a Room

To join a specific room, use the /join command within the application:

/join <room_id>

or

/join Room Name

or, after using the /rooms command, you can join a room by its number:

/join <number>

For example, if the /rooms command shows "2. Mark's space", you can join it with /join 2.

Sending Messages

Once in a room, you can type messages directly in the terminal. Press Enter to send.

To send a message that starts with a slash (e.g., "/hello"), prefix it with another slash (e.g., "//hello").

Commands

While in a room, you can use the following commands:

  • /exit - Exit the room
  • /help - Show this help message
  • /rooms [filter] - List all rooms, optionally filtered by text
  • /teams [filter] - List all teams that you are a member of, optionally filtered by text
  • /spaces <team name or ID> - List all spaces (rooms) in a specific Webex team
  • /members - List all members in the current room
  • /add <email_address> - Add a user to the current room
  • /details - Display details about the current room
  • /join <room_id> - Join another room
  • /files - List all files in the current room with their IDs
  • /upload <filename> - Upload a file to the current room
  • /download <filename> - Download a file from the current room (can use filename or ID)
  • /open <filename> - Download and open a file from the current room with the default application
  • /person <text> - Search for people by email (if text contains @) or display name
  • /whoami - Display detailed information about your Webex user account
  • /delete - Delete the last message you sent in the room
  • /remove <email_address> - Remove a user from the current room
  • /debug - Toggle debug mode to show/hide message payloads
  • /sound - Toggle notification sound for new messages
  • /logout - Log out from Webex by deleting the token file
  • /nn - Show the last nn messages in the room (where nn is a number between 1 and 10)

To send a message that starts with a slash, prefix it with another slash:

  • //hello - Sends the message '/hello' to the room

Development

Requirements

  • Python 3.7+
  • Dependencies listed in requirements.txt

Setup Development Environment

git clone https://github.com/yourusername/webex-terminal.git
cd webex-terminal
pip install -e ".[dev]"

License

MIT